Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
albrow committed Jan 12, 2018
1 parent 69279b7 commit 332cab2
Showing 1 changed file with 7 additions and 29 deletions.
36 changes: 7 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Contributing
------------

Feedback, bug reports, and pull requests are greatly appreciated :)

### Issues
Expand All @@ -12,39 +15,14 @@ If you are thinking about submitting an issue please remember to:

1. Describe the issue in detail.
2. If applicable, describe the steps to reproduce the error, which probably should include some example code.
3. Mention details about your platform: OS, version of Go and Redis, etc.
3. Mention details about your platform: OS, version of gopherjs, browser, etc.

### Pull Requests

Zoom uses semantic versioning and the [git branching model described here](http://nvie.com/posts/a-successful-git-branching-model/).
If you plan on submitting a pull request, you should:
In order to submit a pull request:

1. Fork the repository.
2. Create a new "feature branch" off of **develop** (not master) with a descriptive name (e.g. fix-database-error).
2. Create a new "feature branch" with a descriptive name (e.g. fix-database-error).
3. Make your changes in the feature branch.
4. Run the tests to make sure that they still pass. Updated the tests if needed.
5. Submit a pull request to merge your feature branch into the **develop** branch. Please do not request to merge directly into master.

### Third-Party Dependencies

Zoom uses [Glide](https://github.com/Masterminds/glide) to manage dependencies.
If you update or add any new dependencies, make sure you edit glide.yaml
appropriately. All dependencies should be locked to a specific version in
glide.yaml.

1. If the project supports semantic versioning and the current version is
greater than or equal to 1.0, the version should be pinned to the current
major version. E.g., `version: 2.x`.
2. If the project supports semantic versioning and the current version is less
than 1.0, the version should be pinned to the latest patch. E.g.,
`version: 0.4.2`.
3. If the project does not support semantic versioning, then the version should
be pinned to the latest commit hash. E.g.,
`ref: 2b2c4ccb8692bb9d0ac6411c1fe47bb04be0ee05`.

After you have added/updated a dependency, be sure to run `glide install` to
have Glide install the appropriate version to the `vendor` directory. Then run
`git add -f vendor` to have add the dependency to version control as a
submodule. Submodules are certainly confusing and not ideal, but this is the
only way we know of to install dependencies in the `vendor` folder in a way that
will work with `go get` for users who do not have Glide.
5. Submit a pull request to merge your feature branch into the *master* branch.

0 comments on commit 332cab2

Please sign in to comment.