elvish/CONTRIBUTING.md

Notes for Contributors

Code Checklist

1. Always run unit tests before committing. make will take care of this.

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.

   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.

   To automate this you can set up a goimports filter for Git by putting this in ~/.gitconfig:

   [filter "goimports"]
       clean = goimports
       smudge = cat
   

   Git will then always run goimports for you before committing, since .gitattributes in this repository refers to this filter. More about Git attributes and filters here.

Human Communication

If you are making significant changes or any user-visible changes (e.g. changes to the language, the UI or the elv script API), please discuss on the developer channel before starting to work.

Licensing

By contributing, you agree to license your code under the same license as existing source code of elvish. See the LICENSE file.