mirror of
https://github.com/gravitl/netmaker.git
synced 2024-09-22 00:06:04 +08:00
29 lines
2 KiB
Markdown
29 lines
2 KiB
Markdown
|
# Contributing to Netmaker
|
||
|
|
Welcome! If you're reading this, you might be wondering how to go about submitting some changes, whether those are features, bugfixes, or simple enhancements. You're in the right place. Please read below to learn more.
|
||
|
|
|
||
|
|
## Code of Conduct
|
||
|
|
|
||
|
|
Please read through our [code of conduct](./CODE_OF_CONDUCT.md), and when making contributions to the community, stay true to that text.
|
||
|
|
|
||
|
|
## Report bugs and requests [here](https://github.com/gravitl/netmaker/issues)
|
||
|
|
We use GitHub issues to track bugs, feature requests, and enhancements. If you think there's something missing or wrong with Netmaker, let us know! Try to add the appropriate tags and describe your issue thoroughly. If it's a feature request and we like it, we'll add it to the [roadmap](ROADMAP.md)
|
||
|
|
|
||
|
|
## Submitting a PR
|
||
|
|
We actively welcome contributions, and the way to do that is with a PR:
|
||
|
|
|
||
|
|
1. Fork the repo
|
||
|
|
2. Create a branch from `develop` based on what you are developing. In general this will be a feature or a bugfix branch, and should have the format of feature_vX.X_mynewfeature or bugfix_vX.X_mybugfix. Check the releases to see what minor version we are currently developing.
|
||
|
|
3. Do your thing
|
||
|
|
4. Document thoroughly
|
||
|
|
5. Issue a PR to `develop`
|
||
|
|
6. Sign the CLA
|
||
|
|
|
||
|
|
## Contributor License Agreement
|
||
|
|
|
||
|
|
When submitting a PR, you will be asked to sign a CLA, defined [here](https://gist.github.com/afeiszli/2f9f8133929e7d5574a9d892959d58a7). We've tried to make this as non-annoying as possible. This is adapted from the text used by the Apache Foundation in their CLA.
|
||
|
|
|
||
|
|
This project is evolving quickly and we may want to move to an MIT or GPL license at some point in the near future, which would be difficult without a CLA.
|
||
|
|
|
||
|
|
## Licensing
|
||
|
|
Any contributions you make will be under the SSPL Software License. When you submit code changes, you understand that they will be under the same license that covers this project, defined [here](../LICENSE.txt). If you have any concerns around this, feel free to contact the maintainers.
|