Skip to content

Latest commit

 

History

History
92 lines (62 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

92 lines (62 loc) · 3.51 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

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

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

Prerequisites for running and testing code

GitHub Codespace

The repository includes a pre-configured devcontainer that handles most prerequisites. To use it:

  1. Create a fork of the repository
  2. Click the green "Code" button on the repository
  3. Select the "Codespaces" tab
  4. Click "Create Codespace on main" (or on the branch you want to work on)

This will create a cloud-based development environment with:

  • Go installation
  • Required development tools
  • Project dependencies
    • GitHub CLI (gh)
  • Several Visual Studio Code extensions for Go development and GitHub integration
  • Pre-configured linting and testing tools

The environment will be ready to use in a few minutes.

Local development environment

These are one-time installations required to be able to test your changes locally as part of the pull request (PR) submission process.

  1. install Go through download | through Homebrew
  2. install golangci-lint

Building the extension

You can build from source using the following command:

go build -o gh-skyline

However, you'll want to test your changes in the GitHub CLI before you raise a Pull Request. To make that easier in local development, you could consider using the provided rebuild script:

./rebuild.sh

This script will:

  1. Remove any existing installation of the gh-skyline extension
  2. Build the extension from source
  3. Install the local version for testing

Testing

Run the full test suite with:

go test ./...

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: script/bootstrap
  3. Make sure the tests pass on your machine: go test -v ./...
  4. Make sure linter passes on your machine: golangci-lint run
  5. Create a new branch: git checkout -b my-branch-name
  6. Make your change, add tests, and make sure the tests and linter still pass
  7. Push to your fork and submit a pull request
  8. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide.
  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Resources