go-sylixos/elvish
3
0
Fork 0
mirror of https://github.com/go-sylixos/elvish.git synced 2024-12-15 03:37:52 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

CONTRIBUTING: Document all codegen deps.

Browse Source
This commit is contained in:
Qi Xiao 2018-01-01 15:06:07 +00:00
parent acb157d929
commit f234e65d41
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -6,7 +6,13 @@
2. Some files are generated from other files. They should be committed into the repository for this package to be go-gettable. Run `go generate ./...` to regenerate them in case you modified the source.
We use the `stringer` tool in some generation rules. Install with `go get -u golang.org/x/tools/cmd/stringer`.
Dependencies of the generation rules:
* The `stringer` tool: Install with `go get -u golang.org/x/tools/cmd/stringer`;
* An installed `elvish` in your PATH;
* Python 2.7 at `/usr/bin/python2.7` (Python scripts should be rewritten in either Go or Elvish).
3. Always format the code with `goimports` before committing. Run `go get golang.org/x/tools/cmd/goimports` to install `goimports`, and `goimports -w .` to format all golang sources.