Skip to content

Commit

Permalink
CONTRIBUTING: create a new further reading section
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
sivaraam committed Jun 25, 2018
1 parent 82f5776 commit f501bda
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -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.
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

We require contributors to include Javadocs for all new methods and classes
Expand All @@ -34,3 +32,7 @@ The body should provide a meaningful commit message.
1. Write tests for your code (if possible)

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)

0 comments on commit f501bda

Please sign in to comment.