Skip to content

Commit 1ae28e3

Browse files
sivaraamVivek Maskara
authored and
Vivek Maskara
committed
CONTRIBUTING: fix formatting of the gist of the guidelines (#1453)
* CONTRIBUTING: fix formatting of the gist of the guidelines First level headings for a gist seems to be overkill. So, replace first level headings with an ordered-list which sounds more meaningful. * CONTRIBUTING: specify clearly that 'blame' is a feature of "Git" The contributing file specifies about the ability to know who wrote something without the need of @author javadoc tags but incorrectly attributes the feature to GitHub. Correctly attribute the feature to where it belongs, Git, and specify the name of the feature to help users easily take advantage of it.
1 parent 8eed630 commit 1ae28e3

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

CONTRIBUTING.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,30 @@ If you're not sure where to start head on to [this wiki page](https://github.com
55

66
Here's a gist of the guidelines,
77

8-
# Make separate commits for logically separate changes
8+
1. Make separate commits for logically separate changes
99

10-
# Describe your changes well in the commit message
10+
1. Describe your changes well in the commit message
1111

12-
The first line of the commit message should be a short description of what has
12+
The first line of the commit message should be a short description of what has
1313
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
17+
1. Write Javadocs
1818

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:
19+
We require contributors to include Javadocs for all new methods and classes
20+
submitted via PRs (after 1 May 2018). This is aimed at making it easier for
21+
new contributors to dive into our codebase, especially those who are new to
22+
Android development. A few things to note:
2023

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+
- This should not replace the need for code that is easily-readable in
25+
and of itself
26+
- Please make sure that your Javadocs are reasonably descriptive, not just
27+
a copy of the method name
28+
- Please do not use `@author` tags - we aim for collective code ownership,
29+
and if needed, Git allows us to see who wrote something without needing
30+
to add these tags (`git blame`)
2431

25-
# Write tests for your code (if possible)
32+
1. Write tests for your code (if possible)
2633

27-
# Make sure the Wiki pages don't become stale by updating them (if needed)
34+
1. Make sure the Wiki pages don't become stale by updating them (if needed)

0 commit comments

Comments
 (0)