github.com/aleksi/gonuts.io@v0.0.0-20130622121132-3b0f2d1999fb/CONTRIBUTING.md (about) 1 Filling issues and contributing to gonuts.io 2 ============================================ 3 4 First of all, thank you for your interest in making packaging 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. Enable debug output: set "Debug" to "true" in `~/.nut.json`. 17 2. Make sure bug is reproducible with latest released version: `go get -u github.com/AlekSi/nut/...`. 18 3. Search for [existing bug report](https://github.com/AlekSi/nut/issues). 19 4. Create a new issue if needed. Please do not assign any label. 20 5. Include output of: 21 22 (cd $GOPATH/src/github.com/AlekSi/nut && git describe --tags) 23 go env 24 25 6. Include any other information you think may help. 26 27 Proposing features 28 ------------------ 29 30 Please add your comments to [existing feature requests](https://github.com/AlekSi/gonuts.io/issues?labels=feature), but do not create new without proposing them in [mailing list](https://groups.google.com/group/gonuts-io) first. 31 32 Contributing changes 33 -------------------- 34 35 1. Read all previous sections first. 36 2. You can make small changes right in the web interface. Spot a typo? Fix it! :) 37 3. For bigger changes make a fork on GitHub and clone it into `$GOPATH/src/github.com/AlekSi/gonuts.io`. 38 4. Run `make prepare` to install remote packages and `make run` to run local server. 39 5. Create a topic branch. 40 6. Make your changes. 41 7. Publish your topic branch. 42 8. Make a pull request.