summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Martin Szulecki2020-06-13 04:23:21 +0200
committerGravatar Martin Szulecki2020-06-13 04:23:21 +0200
commit95b124354cd40bb11e2217c56ed5d3d682a5d21a (patch)
treea089c844fa8d6346c4cf1fe7085d507b45158ce7 /README.md
parenteabee2d53c129fb9ba3ed60a0f545f18a5a805e6 (diff)
downloadidevicerestore-95b124354cd40bb11e2217c56ed5d3d682a5d21a.tar.gz
idevicerestore-95b124354cd40bb11e2217c56ed5d3d682a5d21a.tar.bz2
Add "contributing" section to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index d7d6d42..eb53dd8 100644
--- a/README.md
+++ b/README.md
@@ -113,6 +113,25 @@ idevicerestore --help
man idevicerestore
```
+## 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/