From 6dc79ddc11a97a2a684d6b5b6ebcd751f8609188 Mon Sep 17 00:00:00 2001 From: Martin Szulecki Date: Sat, 13 Jun 2020 04:22:19 +0200 Subject: Add "contributing" section to README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 6f0944a..12bd0a1 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,25 @@ ideviceactivation --help man ideviceactivation ``` +## 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/ -- cgit v1.1-32-gdbae