diff options
author | Martin Szulecki | 2020-06-13 04:17:44 +0200 |
---|---|---|
committer | Martin Szulecki | 2020-06-13 04:17:44 +0200 |
commit | 27ff99b5eef881775ec669baad5ab670d7ff9fa4 (patch) | |
tree | 05f26f1967c45f46e86eb50993bd6d6a0634577f /README.md | |
parent | 1b172b6979469f7243d942deadad5256b2e610b1 (diff) | |
download | libirecovery-27ff99b5eef881775ec669baad5ab670d7ff9fa4.tar.gz libirecovery-27ff99b5eef881775ec669baad5ab670d7ff9fa4.tar.bz2 |
Add "contributing" section to README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -70,6 +70,25 @@ irecovery --help man irecovery ``` +## Contributing + +We welcome contributions from anyone and are grateful for every pull request! + +If you'd like to contribute, please fork the `master` branch, change, commit and +send a pull request for review. Once approved it can be merged into the main +code base. + +If you plan to contribute larger changes or a major refactoring, please create a +ticket first to discuss the idea upfront to ensure less effort for everyone. + +Please make sure your contribution adheres to: +* Try to follow the code style of the project +* Commit messages should describe the change well without being to short +* Try to split larger changes into individual commits of a common domain +* Use your real name and a valid email address for your commits + +We are still working on the guidelines so bear with us! + ## Links * Homepage: https://libimobiledevice.org/ |