diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..0734537f2 --- /dev/null +++ b/CHANGELOG.md @@ -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)* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..c221dd5b0 --- /dev/null +++ b/CONTRIBUTING.md @@ -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)* diff --git a/README.md b/README.md index 15eea49d7..77cf2b5dc 100644 --- a/README.md +++ b/README.md @@ -335,3 +335,7 @@ trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies. + +--- + +*[Mukller](https://github.com/Mukller)*