From 2f02a79df0ef2f9eba22429767bc6d4cb67d1f87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Fri, 17 Apr 2020 15:29:12 +0200 Subject: [PATCH] Touch up CONTRIBUTING docs :nail_care: --- .github/CONTRIBUTING.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ce97652f9..6327dfd66 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,21 +12,31 @@ Please do: * open an issue if things aren't working as expected * open an issue to propose a significant change -* open a PR to fix a bug -* open a PR if a member of the GitHub CLI team has given the ok after discussion in an issue +* open a pull request to fix a bug +* open a pull request if a member of the GitHub CLI team has given the ok after discussion in an issue + +## Building the project + +Prerequisites: +- Go 1.13 + +Build with: `make` or `go build -o bin/gh ./cmd/gh` + +Run the new binary as: `./bin/gh` + +Run tests with: `make test` or `go test ./...` ## Submitting a pull request -0. Clone this repository -0. Create a new branch: `git checkout -b my-branch-name` -0. Make your change, add tests, and ensure tests pass -0. Make a PR: `gh pr create --web` +1. Create a new branch: `git checkout -b my-branch-name` +1. Make your change, add tests, and ensure tests pass +1. Submit a pull request: `gh pr create --web` Contributions to this project are [released][legal] to the public under the [project's open source license][license]. 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. -We generate manual pages from source on every release! You do not need to submit PRs for those specifically; the docs will get updated if your PR gets accepted. +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. ## Resources