Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 3.24 KB
Raw

Contributing

Hi! Thanks for your interest in contributing to the GitHub CLI!

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.

Please do:

  • Check existing issues to verify that the bug or feature request has not already been submitted.
  • Open an issue if things aren't working as expected.
  • Open an issue to propose a significant change.
  • Open a pull request to fix a bug.
  • Open a pull request to fix documentation about a command.
  • Open a pull request for any issue labelled help wanted or good first issue.

Please avoid:

  • Opening pull requests for issues marked needs-design, needs-investigation, or blocked.
  • Adding installation instructions specifically for your OS/package manager.
  • Opening pull requests for any issue marked core. These issues require additional context from the core CLI team at GitHub and any external pull requests will not be accepted.

Building the project

Prerequisites:

  • Go 1.13+ for building the binary
  • Go 1.15+ for running the test suite

Build with:

  • Unix-like systems: make
  • Windows: go run script/build.go

Run the new binary as:

  • Unix-like systems: bin/gh
  • Windows: bin\gh

Run tests with: go test ./...

Submitting a pull request

  1. Create a new branch: git checkout -b my-branch-name
  2. Make your change, add tests, and ensure tests pass
  3. Submit a pull request: gh pr create --web

Contributions to this project are released to the public under the project's open source license.

Please note that this project adheres to a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

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.

Design guidelines

You may reference the CLI Design System when suggesting features, and are welcome to use our Google Docs Template to suggest designs.

Resources