github.com/rhettli/gopher-lua@v0.0.0-20200830072439-712e2f816099/.github/CONTRIBUTING.md (about) 1 # How to Contribute 2 Any kind of contributions are welcome. 3 4 ## Building GopherLua 5 6 GopherLua uses simple inlining tool for generate efficient codes. This tool requires python interpreter. Files name of which starts with `_` genarate files name of which does not starts with `_` . For instance, `_state.go` generate `state.go` . You do not edit generated sources. 7 To generate sources, some make target is available. 8 9 ```bash 10 make build 11 make glua 12 make test 13 ``` 14 15 You have to run `make build` before committing to the repository. 16 17 ## Pull requests 18 Our workflow is based on the [github-flow](https://guides.github.com/introduction/flow/>) . 19 20 1. Create a new issue. 21 2. Fork the project. 22 3. Clone your fork and add the upstream. 23 ```bash 24 git remote add upstream https://github.com/yuin/gopher-lua.git 25 ``` 26 27 4. Pull new changes from the upstream. 28 ```bash 29 git checkout master 30 git fetch upstream 31 git merge upstream/master 32 ``` 33 34 5. Create a feature branch 35 ```bash 36 git checkout -b <branch-name> 37 ``` 38 39 6. Commit your changes and reference the issue number in your comment. 40 ```bash 41 git commit -m "Issue #<issue-ref> : <your message>" 42 ``` 43 44 7. Push the feature branch to your remote repository. 45 ```bash 46 git push origin <branch-name> 47 ``` 48 49 8. Open new pull request.