forked from elves/elvish
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move the "contributing" section to a shiny CONTRIBUTING.md file
- Loading branch information
Showing
2 changed files
with
25 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Notes for Contributors | ||
|
||
## Testing | ||
|
||
Always run unit tests before committing. `make` will take care of this. | ||
|
||
## Generated files | ||
|
||
Some files are generated from other files. They should be commmited into the repository for this package to be go-getable. Run `go generate ./...` to regenerate them in case you modified the source. | ||
|
||
## Formatting the Code | ||
|
||
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 comitting, since `.gitattributes` in this repository refers to this filter. More about Git attributes and filters [here](https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html). | ||
|
||
## Licensing | ||
|
||
By contributing, you agree to license your code under the same license as existing source code of elvish. See the LICENSE file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters