mirror of
https://github.com/commons-app/apps-android-commons.git
synced 2025-10-26 12:23:58 +01:00
CONTRIBUTING: create a new further reading section
As we don't want to clutter up the gist with a lot of information. Move the link to the informative blog post to the new further reading section.
This commit is contained in:
parent
82f5776322
commit
f501bdaa71
1 changed files with 4 additions and 2 deletions
|
|
@ -14,8 +14,6 @@ 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.
|
is a filename or identifier for the general area of the code being modified.
|
||||||
The body should provide a meaningful commit message.
|
The body should provide a meaningful commit message.
|
||||||
|
|
||||||
Read the importance of good commit messages in the [linked blog post](https://blog.oozou.com/commit-messages-matter-60309983c227?gi=c550a10d0f67).
|
|
||||||
|
|
||||||
1. Write Javadocs
|
1. Write Javadocs
|
||||||
|
|
||||||
We require contributors to include Javadocs for all new methods and classes
|
We require contributors to include Javadocs for all new methods and classes
|
||||||
|
|
@ -34,3 +32,7 @@ The body should provide a meaningful commit message.
|
||||||
1. Write tests for your code (if possible)
|
1. Write tests for your code (if possible)
|
||||||
|
|
||||||
1. Make sure the Wiki pages don't become stale by updating them (if needed)
|
1. Make sure the Wiki pages don't become stale by updating them (if needed)
|
||||||
|
|
||||||
|
### Further reading
|
||||||
|
|
||||||
|
* [Importance of good commit messages](https://blog.oozou.com/commit-messages-matter-60309983c227?gi=c550a10d0f67)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue