summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Manuel <nilslice@gmail.com>2016-10-19 14:07:53 -0700
committerSteve Manuel <nilslice@gmail.com>2016-10-19 14:07:53 -0700
commit22ead33fc9dbf768b4f365cdf1adc1ae901859bb (patch)
tree5c4c2277a07ec2e9fbecf6f66a7d25db75b1ec86
parent8959286b6d1acb9d247337add6a48c70c37d13e2 (diff)
adding contrib info for other users
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index a9ea230..28a8a72 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,19 @@ to get thoughts/feedback!
$ go get github.com/bosssauce/ponzu/...
```
+## Contributing
+
+1. Checkout branch ponzu-dev
+2. Make code changes
+3. Commit change to ponzu-dev branch (I know, a little unnatural. Advice gladly accepted.)
+ - to manually test, you will need to use a new copy (ponzu new path/to/code), but pass the --dev flag so that ponzu generates a new copy from the ponzu-dev branch, not master by default (i.e. $ponzu --dev new /path/to/code)
+ - build and run with $ ponzu build and $ ponzu run
+4. To add back to master:
+ - first push to origin ponzu-dev
+ - create a pull request
+ - will then be merged into master
+
+
## Credits
- [golang.org/x/text/transform](https://golang.org/x/text/transform)
- [golang.org/x/text/unicode/norm](https://golang.org/x/text/unicode/norm)