You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8Lines changed: 8 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,14 @@ changed. It is also good to prefix the first line with "area: " where the "area"
14
14
is a filename or identifier for the general area of the code being modified.
15
15
The body should provide a meaningful commit message.
16
16
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
+
17
25
# Write tests for your code (if possible)
18
26
19
27
# Make sure the Wiki pages don't become stale by updating them (if needed)
0 commit comments