github.com/aleksi/gonuts.io@v0.0.0-20130622121132-3b0f2d1999fb/gopath/src/gonuts.io/AlekSi/nut/CONTRIBUTING.md (about) 1 Filling issues and contributing to nut tool 2 =========================================== 3 4 First of all, thank you for your interest in making Go ecosystem better! There are number of ways you can help: 5 6 * reporting bugs; 7 * proposing features; 8 * contributing code bug fixes and new features; 9 * contributing documentation fixes (there is probably a ton of grammar errors :/) and improvements. 10 11 The following sections describes those scenarios. Golden rule: communicate first, code later. 12 13 Reporting bugs 14 -------------- 15 16 1. Make sure bug is reproducible with latest released version: `go get -u github.com/AlekSi/nut/...`. 17 2. Search for [existing bug report](https://github.com/AlekSi/nut/issues). 18 3. Create a new issue if needed. Please do not assign any label. 19 4. Include output of: 20 21 (cd $GOPATH/src/github.com/AlekSi/nut && git describe --tags) 22 go env 23 24 5. Include any other information you think may help. 25 26 Proposing features 27 ------------------ 28 29 Please add your comments to [existing feature requests](https://github.com/AlekSi/nut/issues?labels=feature), but do not create new without proposing them in [mailing list](https://groups.google.com/group/gonuts-io) first. 30 31 Contributing changes 32 -------------------- 33 34 1. Read all previous sections first. 35 2. Nut tool uses [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/). Make sure you are starting with branch `develop` for new feature and `master` for bug fix. 36 3. You can make small changes right in the web interface. Spot a typo? Fix it! :) 37 4. For bigger changes setup a separate workspace a.k.a. GOPATH (strictly required for integration tests), make a fork on GitHub and clone it into `$GOPATH/src/github.com/AlekSi/nut`. 38 5. Run `make prepare` to install remote packages and `make` to run unit and integration tests. 39 6. Use `git flow feature start` or `git flow hotfix start` to create a branch. 40 7. Make your changes. Run and update tests. Do not change version. 41 8. Publish your `feature` or `hotfix` branch. 42 9. Make a pull request.