ITQC/containernetworking-plugins
24
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 34 Wiki Activity

docs: Mention license headers and doc contributions

Browse Source 
Closes #174.
This commit is contained in:
Michael Bridgen 2016-05-19 13:40:37 +01:00
parent 991176a64a
commit bcc189e1e6
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -5,6 +5,8 @@ pull requests. This document outlines some of the conventions on development
workflow, commit message formatting, contact points and other resources to make workflow, commit message formatting, contact points and other resources to make
it easier to get your contribution accepted. it easier to get your contribution accepted.
We welcome improvements to documentation as well as to code.
# Certificate of Origin # Certificate of Origin
By contributing to this project you agree to the Developer Certificate of By contributing to this project you agree to the Developer Certificate of
@ -25,17 +27,18 @@ are very busy and read the mailing lists.
- Fork the repository on GitHub - Fork the repository on GitHub
- Read the [README](README.md) for build and test instructions - Read the [README](README.md) for build and test instructions
- Play with the project, submit bugs, submit patches! - Play with the project, submit bugs, submit pull requests!
## Contribution Flow ## Contribution workflow
This is a rough outline of what a contributor's workflow looks like: This is a rough outline of how to prepare a contribution:
- Create a topic branch from where you want to base your work (usually master). - Create a topic branch from where you want to base your work (usually branched from master).
- Make commits of logical units. - Make commits of logical units.
- Make sure your commit messages are in the proper format (see below). - Make sure your commit messages are in the proper format (see below).
- Push your changes to a topic branch in your fork of the repository. - Push your changes to a topic branch in your fork of the repository.
- Make sure the tests pass, and add any new tests as appropriate. - If you changed code, make sure the tests pass, and add any new tests as appropriate.
- Make sure any new code files have a license header.
- Submit a pull request to the original repository. - Submit a pull request to the original repository.
Thanks for your contributions! Thanks for your contributions!