diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..3e36365a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +## Contributing + +Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. + +Contributions to this project are [released](https://docs.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license) +to the public under the [GPL-3.0 License](https://github.com/AnonymusRaccoon/Kyoo/blob/master/LICENSE). + +## Submitting a pull request + +1. [Fork](https://github.com/AnonymusRaccoon/Kyoo/fork) and clone the repository +2. Install the toolstack and/or download precompiled binaries for the transcoder (see [Development & Build](https://github.com/AnonymusRaccoon/Kyoo#development--build)) +3. Create a new branch: `git checkout -b my-branch-name` +4. Make your changes (Please try to follow the same coding style as what has already been made - indent with tabs, align with spaces etc) +5. Make sure the tests pass: `dotnet tests` +6. Push to your fork and [submit a pull request](https://github.com/AnonymusRaccoon/Kyoo/compare) +7. Pat your self on the back and wait for your pull request to be reviewed and merged. + +Here are a few things you can do that will increase the likelihood of your pull request being accepted: + +- Write tests. +- Make sure the `README.md` and any other relevant **documentation are kept up-to-date**. +- We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. +- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as **separate pull requests**. +- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). + +## Resources + +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) +- [Using Pull Requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) +- [GitHub Help](https://docs.github.com/en) diff --git a/README.md b/README.md index 0e25cbd6..5737fb4e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@