summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Martin Szulecki2020-06-13 04:21:11 +0200
committerGravatar Martin Szulecki2020-06-13 04:21:11 +0200
commit13de0244fdf20ba1abc7361140f159d00d9067dd (patch)
tree3a94ab22ed3db0052731631281508768d4dd6b2d
parentfc006aa31f6418de8a5fdf05ba8012b3ed7067ed (diff)
downloadlibusbmuxd-13de0244fdf20ba1abc7361140f159d00d9067dd.tar.gz
libusbmuxd-13de0244fdf20ba1abc7361140f159d00d9067dd.tar.bz2
Add "contributing" section to README.md
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 37311ed..23873b1 100644
--- a/README.md
+++ b/README.md
@@ -117,6 +117,25 @@ ideviceinfo
This sets the usbmuxd socket address to `192.168.179.1:27015` for applications
that use the libusbmuxd library.
+## 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/