mnalis/apps-android-commons
1
0
Fork 0
mirror of https://github.com/commons-app/apps-android-commons.git synced 2025-10-26 12:23:58 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update contributing.md (#1477)

Browse source
This commit is contained in:
Josephine Lim 2018-05-07 04:05:55 +10:00 • committed by Vivek Maskara
parent 693c37f2ec
commit 228aa21290
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -14,6 +14,14 @@ changed. It is also good to prefix the first line with "area: " where the "area"
is a filename or identifier for the general area of the code being modified.
The body should provide a meaningful commit message.
# Write Javadocs
We require contributors to include Javadocs for all new methods and classes submitted via PRs (after 1 May 2018). This is aimed at making it easier for new contributors to dive into our codebase, especially those who are new to Android development. A few things to note:
- This should not replace the need for code that is easily-readable in and of itself
- Please make sure that your Javadocs are reasonably descriptive, not just a copy of the method name
- Please do not use `@author` tags - we aim for collective code ownership, and if needed, GitHub allows us to see who wrote something without needing to add these tags
# Write tests for your code (if possible)
# Make sure the Wiki pages don't become stale by updating them (if needed)