github.com/ungtb10d/cli/v2@v2.0.0-20221110210412-98537dd9d6a1/.github/CONTRIBUTING.md (about)

     1  ## Contributing
     2  
     3  Hi! Thanks for your interest in contributing to the GitHub CLI!
     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 about a command.
    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  * Adding installation instructions specifically for your OS/package manager.
    20  * Opening pull requests for any issue marked `core`. These issues require additional context from
    21    the core CLI team at GitHub and any external pull requests will not be accepted.
    22  
    23  ## Building the project
    24  
    25  Prerequisites:
    26  - Go 1.16+
    27  
    28  Build with:
    29  * Unix-like systems: `make`
    30  * Windows: `go run script/build.go`
    31  
    32  Run the new binary as:
    33  * Unix-like systems: `bin/gh`
    34  * Windows: `bin\gh`
    35  
    36  Run tests with: `go test ./...`
    37  
    38  See [project layout documentation](../docs/project-layout.md) for information on where to find specific source files.
    39  
    40  ## Submitting a pull request
    41  
    42  1. Create a new branch: `git checkout -b my-branch-name`
    43  1. Make your change, add tests, and ensure tests pass
    44  1. Submit a pull request: `gh pr create --web`
    45  
    46  Contributions to this project are [released][legal] to the public under the [project's open source license][license].
    47  
    48  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.
    49  
    50  We generate manual pages from source on every release. You do not need to submit pull requests for documentation specifically; manual pages for commands will automatically get updated after your pull requests gets accepted.
    51  
    52  ## Design guidelines
    53  
    54  You may reference the [CLI Design System][] when suggesting features, and are welcome to use our [Google Docs Template][] to suggest designs.
    55  
    56  ## Resources
    57  
    58  - [How to Contribute to Open Source][]
    59  - [Using Pull Requests][]
    60  - [GitHub Help][]
    61  
    62  
    63  [bug issues]: https://github.com/ungtb10d/cli/issues?q=is%3Aopen+is%3Aissue+label%3Abug
    64  [feature request issues]: https://github.com/ungtb10d/cli/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement
    65  [hw]: https://github.com/ungtb10d/cli/labels/help%20wanted
    66  [gfi]: https://github.com/ungtb10d/cli/labels/good%20first%20issue
    67  [legal]: https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-terms-of-service#6-contributions-under-repository-license
    68  [license]: ../LICENSE
    69  [code-of-conduct]: ./CODE-OF-CONDUCT.md
    70  [How to Contribute to Open Source]: https://opensource.guide/how-to-contribute/
    71  [Using Pull Requests]: https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests
    72  [GitHub Help]: https://docs.github.com/
    73  [CLI Design System]: https://primer.style/cli/
    74  [Google Docs Template]: https://docs.google.com/document/d/1JIRErIUuJ6fTgabiFYfCH3x91pyHuytbfa0QLnTfXKM/edit#heading=h.or54sa47ylpg