youtubebeat/vendor/github.com/magefile/mage/CONTRIBUTING.md

43 lines
1.3 KiB
Markdown
Raw Normal View History

2018-11-18 11:08:38 +01:00
# Contributing
Of course, contributions are more than welcome. Please read these guidelines for
making the process as painless as possible.
## Discussion
Development discussion should take place on the #mage channel of [gopher
slack](https://gophers.slack.com/).
There is a separate #mage-dev channel that has the github app to post github
activity to the channel, to make it easy to follow.
## Issues
If there's an issue you'd like to work on, please comment on it, so we can
discuss approach, etc. and make sure no one else is currently working on that
issue.
Please always create an issue before sending a PR unless it's an obvious typo
or other trivial change.
## Dependency Management
Currently mage has no dependencies(!) outside the standard libary. Let's keep
it that way. Since it's likely that mage will be vendored into a project,
adding dependencies to mage adds dependencies to every project that uses mage.
## Versions
Please avoid using features of go and the stdlib that prevent mage from being
buildable with older versions of Go. The CI tests currently check that mage is
buildable with go 1.7 and later. You may build with whatever version you like,
but CI has the final say.
## Testing
Please write tests for any new features. Tests must use the normal go testing
package.
Tests must pass the race detector (run `go test -race ./...`).