path: root/
diff options
authorGravatar Martin Szulecki2020-06-13 04:21:34 +0200
committerGravatar Martin Szulecki2020-06-13 04:21:34 +0200
commit66d606871079d588316c5374bdd288225cc4df48 (patch)
tree87f722a3f02d01de1992689d2aee2e1213f18b89 /
parent1d8fc73728b424e690d76361a3ff3831d6241e33 (diff)
Add "contributing" section to
Diffstat (limited to '')
1 files changed, 19 insertions, 0 deletions
diff --git a/ b/
index ed37ae9..35e62c8 100644
--- a/
+++ b/
@@ -138,6 +138,25 @@ ideviceinfo --help
man ideviceinfo
+## 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: