forked from LaconicNetwork/kompose
8fcbc60969
* Cleanup mentions about glide * Don't use glide to ignore vendor directory Since go-1.9, "./..." no longer contains the "vendor" directory. Also, since #1305 migrated dependency management from glide to go mod, there is no need to think about the "vendor" directory. See: https://golang.org/doc/go1.9#vendor-dotdotdot * go mod tidy
29 lines
1.6 KiB
Markdown
29 lines
1.6 KiB
Markdown
# Contributing guidelines
|
|
|
|
## How to become a contributor and submit your own code
|
|
|
|
### Contributor License Agreements
|
|
|
|
We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.
|
|
|
|
Please fill out either the individual or corporate Contributor License Agreement (CLA).
|
|
|
|
* If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.
|
|
* If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.
|
|
|
|
Contact one of the [OWNERS](OWNERS) on Slack to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
|
|
|
|
### Contributing A Patch
|
|
|
|
1. Submit an issue describing your proposed change to the repo in question.
|
|
2. The [repo owners](OWNERS) will respond to your issue promptly.
|
|
3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
|
|
4. Fork the desired repo, develop and test your code changes.
|
|
5. Submit a pull request.
|
|
|
|
Note: Code-related PR's require one ACK / LGTM from a maintainer or core contributor. Doc-related PR's require either one or none depending on the content changed (for example, a spec change would require one, but a spelling error would require none).
|
|
|
|
### Adding dependencies
|
|
|
|
If your patch depends on new packages, make sure that both `go.mod` and `go.sum` are updated properly. Also we recommend you to execute `go mod tidy` before sending a pull request.
|