Add a CONTRIBUTING guide

markusfisch · Dec 19, 2023 · f261613 · f261613
1 parent 8e41184
commit f261613
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# Contribution Guidelines
+
+Please try to keep things in good shape and comply to what's there.
+
+This project follows Android [best practices][android_best_practices]
+so please have a look if you've never heard of them.
+
+The code is formatted according to Android Studio's standard, with the
+exception of indent being tabs instead of spaces.
+
+Use the feature branch workflow to add new features and make sure
+to squash when merging into master:
+
+	$ git merge cool_feature --squash
+
+Then write a [good commit message][commit_messages] to keep the history
+meaningful and useful. One feature, one commit.
+
+[android_best_practices]: https://developer.android.com/distribute/best-practices/develop/
+[commit_messages]: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines