Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Future features will be listed here

### Changed
- Ongoing updates

### Fixed
- Bug fixes

---
*[Mukller](https://github.com/Mukller)*
30 changes: 30 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone.

## Our Standards

Examples of behavior that contributes to a positive environment:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints
- Gracefully accepting constructive criticism
- Focusing on what is best for the community

Examples of unacceptable behavior:
- Harassment of any kind
- Trolling, insulting or derogatory comments
- Public or private harassment
- Publishing others' private information without permission

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

---
*[Mukller](https://github.com/Mukller)*
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing

Thank you for your interest in contributing!

## Getting Started

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/your-feature`
3. Make your changes
4. Run tests: `pytest`
5. Submit a Pull Request

## Code Style

- Follow existing code style and conventions
- Write clear, descriptive commit messages
- Add tests for new features

## Reporting Issues

Use GitHub Issues to report bugs or request features. Please include:
- Steps to reproduce
- Expected vs actual behavior
- Environment details

## Pull Request Guidelines

- Keep PRs focused on a single change
- Update documentation as needed
- Ensure all tests pass

---
*[Mukller](https://github.com/Mukller)*
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,8 @@ If you find `layoutparser` helpful to your work, please consider citing our tool
journal={arXiv preprint arXiv:2103.15348},
year={2021}
}
```
```

---

*[Mukller](https://github.com/Mukller)*