github.com/chelnak/go-gh@v0.0.2/.github/CONTRIBUTING.md (about)

     1  ## Contributing
     2  
     3  Hi! Thanks for your interest in contributing to the GitHub CLI Module!
     4  
     5  We accept pull requests for bug fixes and features where we've discussed the approach in an issue and given the go-ahead for a community member to work on it. We'd also love to hear about ideas for new features as issues.
     6  
     7  Please do:
     8  
     9  * Check existing issues to verify that the [bug][bug issues] or [feature request][feature request issues] has not already been submitted.
    10  * Open an issue if things aren't working as expected.
    11  * Open an issue to propose a significant change.
    12  * Open a pull request to fix a bug.
    13  * Open a pull request to fix documentation.
    14  * Open a pull request for any issue labelled [`help wanted`][hw] or [`good first issue`][gfi].
    15  
    16  Please avoid:
    17  
    18  * Opening pull requests for issues marked `needs-design`, `needs-investigation`, or `blocked`.
    19  * Opening pull requests for any issue marked `core`. These issues require additional context from
    20    the core CLI team at GitHub and any external pull requests will not be accepted.
    21  
    22  ## Submitting a pull request
    23  
    24  1. Create a new branch: `git checkout -b my-branch-name`
    25  1. Make your change, add tests, and ensure tests pass
    26  1. Submit a pull request: `gh pr create --web`
    27  
    28  Contributions to this project are [released][legal] to the public under the [project's open source license][license].
    29  
    30  Please note that this project adheres to a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
    31  
    32  ## Resources
    33  
    34  - [How to Contribute to Open Source][]
    35  - [Using Pull Requests][]
    36  - [GitHub Help][]
    37  
    38  
    39  [bug issues]: https://github.com/cli/go-gh/issues?q=is%3Aopen+is%3Aissue+label%3Abug
    40  [feature request issues]: https://github.com/cli/go-gh/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement
    41  [hw]: https://github.com/cli/go-gh/labels/help%20wanted
    42  [gfi]: https://github.com/cli/go-gh/labels/good%20first%20issue
    43  [legal]: https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-terms-of-service#6-contributions-under-repository-license
    44  [license]: ../LICENSE
    45  [code-of-conduct]: ./CODE-OF-CONDUCT.md
    46  [How to Contribute to Open Source]: https://opensource.guide/how-to-contribute/
    47  [Using Pull Requests]: https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests
    48  [GitHub Help]: https://docs.github.com/