Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Commit

Permalink
Update CONTRIBUTING.md with contribution guidelines for the repo
Browse files Browse the repository at this point in the history
  • Loading branch information
geauxvirtual committed Nov 25, 2015
1 parent 0c65a13 commit fa4147a
Showing 1 changed file with 52 additions and 1 deletion.
53 changes: 52 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,56 @@
#Contributing
#Contributing to snap

snap is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document
will cover how to contribute code, report issues, build the project and run the tests.

## Contributing code

Contributing code to snap is a snap (pun intended).
- Fork the project to your own repo
- Create a topic branch from where you want to base your work (usually master)
- Make commit(s) (following commit guidelines below)
- Make sure tests pass and add any new tests
- Run go fmt on your code
- Push your commit(s) to a topic branch in your repo
- Open a pull request against the original repo and follow the pull request guidelines below

The maintainers of the repo utilize a "Looks Good To Me" (LGTM) message in the pull request
to indicate the pull request is good for merging.

### Commit Guidelines

Commits should have logical groupings. A bug fix should be a single commit. A new feature
should be a single commit.

Commit messages should be clear on what is being fixed or added to the code base. If a
commit is addressing an open issue, please start the commit message with "Fix #XXX" or
"Feature #XXX". This will help make the generated changelog for each release easy to read
with what commits were fixes and what commits were features.

### Pull Request Guidelines

Pull requests can contain a single commit or multiple commits. If a pull request adds
a feature but also fixes two bugs, then the pull request should have three commits, one
commit each for the feature and two bug fixes.

Your pull request should be rebased against the current master branch. Please do not merge
the current master branch in with your topic branch, nor use the Update Branch button provided
by GitHub on the pull request page.

## Reporting Issues

Reporting issues are very beneficial to the project. Before reporting an issue, please review current
open issues to see if there are any matches. If there is a match, comment with a +1, or "Also seeing this issue".
If any environment details differ, please add those with your comment to the matching issue.

When reporting an issue, details are key. Include the following:
- OS version
- snap version
- Environment details (virtual, physical, etc.)
- Steps to reproduce
- Actual results
- Expected results

##Build and Test
###Build
In the /snap directory there's a `Makefile` that builds all dependencies and snap.
Expand Down

0 comments on commit fa4147a

Please sign in to comment.