Add CONTRIBUTING.md (#1183)

This commit is contained in:
Warren Fernandes
2020-08-10 22:14:21 -06:00
committed by GitHub
parent 96dc55577f
commit a738b60e52
2 changed files with 51 additions and 11 deletions

View File

@ -30,7 +30,7 @@ name a few. [This list](./projects_using_cobra.md) contains a more extensive lis
* [Suggestions when "unknown command" happens](#suggestions-when-unknown-command-happens)
* [Generating documentation for your command](#generating-documentation-for-your-command)
* [Generating shell completions](#generating-shell-completions)
- [Contributing](#contributing)
- [Contributing](CONTRIBUTING.md)
- [License](#license)
# Overview
@ -755,16 +755,6 @@ Cobra can generate documentation based on subcommands, flags, etc. Read more abo
Cobra can generate a shell-completion file for the following shells: Bash, Zsh, Fish, Powershell. If you add more information to your commands, these completions can be amazingly powerful and flexible. Read more about it in [Shell Completions](shell_completions.md).
# Contributing
1. Fork it
2. Download your fork to your PC (`git clone https://github.com/your_username/cobra && cd cobra`)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Make changes and add them (`git add .`)
5. Commit your changes (`git commit -m 'Add some feature'`)
6. Push to the branch (`git push origin my-new-feature`)
7. Create new pull request
# License
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt)