256
|
1 |
# Contributing to Cobra |
|
2 |
|
|
3 |
Thank you so much for contributing to Cobra. We appreciate your time and help. |
|
4 |
Here are some guidelines to help you get started. |
|
5 |
|
|
6 |
## Code of Conduct |
|
7 |
|
|
8 |
Be kind and respectful to the members of the community. Take time to educate |
|
9 |
others who are seeking help. Harassment of any kind will not be tolerated. |
|
10 |
|
|
11 |
## Questions |
|
12 |
|
|
13 |
If you have questions regarding Cobra, feel free to ask it in the community |
|
14 |
[#cobra Slack channel][cobra-slack] |
|
15 |
|
|
16 |
## Filing a bug or feature |
|
17 |
|
|
18 |
1. Before filing an issue, please check the existing issues to see if a |
|
19 |
similar one was already opened. If there is one already opened, feel free |
|
20 |
to comment on it. |
|
21 |
1. If you believe you've found a bug, please provide detailed steps of |
|
22 |
reproduction, the version of Cobra and anything else you believe will be |
|
23 |
useful to help troubleshoot it (e.g. OS environment, environment variables, |
|
24 |
etc...). Also state the current behavior vs. the expected behavior. |
|
25 |
1. If you'd like to see a feature or an enhancement please open an issue with |
|
26 |
a clear title and description of what the feature is and why it would be |
|
27 |
beneficial to the project and its users. |
|
28 |
|
|
29 |
## Submitting changes |
|
30 |
|
|
31 |
1. CLA: Upon submitting a Pull Request (PR), contributors will be prompted to |
|
32 |
sign a CLA. Please sign the CLA :slightly_smiling_face: |
|
33 |
1. Tests: If you are submitting code, please ensure you have adequate tests |
|
34 |
for the feature. Tests can be run via `go test ./...` or `make test`. |
|
35 |
1. Since this is golang project, ensure the new code is properly formatted to |
|
36 |
ensure code consistency. Run `make all`. |
|
37 |
|
|
38 |
### Quick steps to contribute |
|
39 |
|
|
40 |
1. Fork the project. |
|
41 |
1. Download your fork to your PC (`git clone https://github.com/your_username/cobra && cd cobra`) |
|
42 |
1. Create your feature branch (`git checkout -b my-new-feature`) |
|
43 |
1. Make changes and run tests (`make test`) |
|
44 |
1. Add them to staging (`git add .`) |
|
45 |
1. Commit your changes (`git commit -m 'Add some feature'`) |
|
46 |
1. Push to the branch (`git push origin my-new-feature`) |
|
47 |
1. Create new pull request |
|
48 |
|
|
49 |
<!-- Links --> |
|
50 |
[cobra-slack]: https://gophers.slack.com/archives/CD3LP1199 |