faas-rs/faas
1
0
Fork 0
mirror of https://github.com/openfaas/faas.git synced 2025-06-22 23:03:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source 
Adds guidelines for commit message formatting with rules
from Chris Beams' blog post here:

https://chris.beams.io/posts/git-commit/

Signed-off-by: Alex Ellis <alexellis2@gmail.com>
This commit is contained in:
Alex Ellis
2018-03-18 18:52:03 +00:00
committed by GitHub
parent 30cf8de89b
commit de22f69dd5
1 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@ -50,12 +50,36 @@ If you are proposing a new tool or service please do due diligence. Does this to
Please read this whole guide and make sure you agree to our DCO agreement (included below): Please read this whole guide and make sure you agree to our DCO agreement (included below):
* See guidelines on commit messages (below)
* Sign-off your commits * Sign-off your commits
* Complete the whole template for issues and pull requests * Complete the whole template for issues and pull requests
* [Reference addressed issues](https://help.github.com/articles/closing-issues-using-keywords/) in the PR description & commit messages - use 'Fixes #IssueNo' * [Reference addressed issues](https://help.github.com/articles/closing-issues-using-keywords/) in the PR description & commit messages - use 'Fixes #IssueNo'
* Always give instructions for testing * Always give instructions for testing
* Provide us CLI commands and output or screenshots where you can * Provide us CLI commands and output or screenshots where you can
**Commit messages**
The first line of the commit message is the *subject*, this should be followed by a blank line and then a message describing the intent and purpose of the commit.
* When you run `git commit` make sure you sign-off the commit by typing `git commit -s`.
* The commit subject should start with an uppercase letter
* The commit subject should not exceed 50 characters in length
* When giving a commit body, leave a blank line then make you wrap all text to 72 characters
Here's an example:
```
Add alexellis to the .DEREK.yml file
We need to add alexellis to the .DEREK.yml file for project maintainer
duties.
Signed-off-by: Alex Ellis >alex@openfaas.com>
```
**Unit testing with Golang** **Unit testing with Golang**
Please follow style guide on [this blog post](https://blog.alexellis.io/golang-writing-unit-tests/) from [The Go Programming Language](https://www.amazon.co.uk/Programming-Language-Addison-Wesley-Professional-Computing/dp/0134190440) Please follow style guide on [this blog post](https://blog.alexellis.io/golang-writing-unit-tests/) from [The Go Programming Language](https://www.amazon.co.uk/Programming-Language-Addison-Wesley-Professional-Computing/dp/0134190440)