diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bcf160f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing + +Thank you for your interest in contributing! + +## License + +By submitting a pull request or otherwise contributing to this repository, you agree that your contributions are licensed under both the **Apache 2.0** and **MIT** licenses, the same as the Osiris project itself. + +Please ensure all commits comply with these licensing terms and include proper attribution where applicable. + +## How to contribute + +1. Fork or create a feature branch (e.g., `feature/`, `fix/`, `test/`) based on the `main` branch. +2. Make your changes with clear, descriptive commit messages. +3. Write tests and proofs for your changes. +4. Ensure that all tests and all proofs pass. +5. Run the formatter. +6. Open a merge request with a clear description of your changes. (reference the issue that gets resolved by the PR, if any.) diff --git a/README.md b/README.md index ebf3150..299bc5e 100644 --- a/README.md +++ b/README.md @@ -69,3 +69,11 @@ $ just hooks Osiris is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details. + +## Contributing + +Read the [CONTRIBUTING.md](CONTRIBUTING.md) before submitting a pull request or otherwise contributing to this repository. + +## Contact + +Osiris was created and is maintained by Thomas Wachter ([@thomasw04](https://github.com/thomasw04/)).