Skip to content

Commit 228aa21

Browse files
misaochanVivek Maskara
authored and
Vivek Maskara
committed
Update contributing.md (commons-app#1477)
1 parent 693c37f commit 228aa21

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ changed. It is also good to prefix the first line with "area: " where the "area"
1414
is a filename or identifier for the general area of the code being modified.
1515
The body should provide a meaningful commit message.
1616

17+
# Write Javadocs
18+
19+
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:
20+
21+
- This should not replace the need for code that is easily-readable in and of itself
22+
- Please make sure that your Javadocs are reasonably descriptive, not just a copy of the method name
23+
- 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
24+
1725
# Write tests for your code (if possible)
1826

1927
# Make sure the Wiki pages don't become stale by updating them (if needed)

0 commit comments

Comments
 (0)