diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0734537 --- /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/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fe9ab1f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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)* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c221dd5 --- /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 bd3b4aa..e43b0b2 100644 --- a/README.md +++ b/README.md @@ -46,4 +46,8 @@ All algorithms are implemented in Python, using numpy, scipy and autograd. Your contributions are always welcome! Feel free to improve existing code, documentation or implement new algorithm. -Please open an issue to propose your changes if they are big enough. +Please open an issue to propose your changes if they are big enough. + +--- + +*[Mukller](https://github.com/Mukller)*