You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+17-7Lines changed: 17 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,21 +12,31 @@ Please do:
12
12
13
13
* open an issue if things aren't working as expected
14
14
* open an issue to propose a significant change
15
-
* open a PR to fix a bug
16
-
* open a PR if a member of the GitHub CLI team has given the ok after discussion in an issue
15
+
* open a pull request to fix a bug
16
+
* open a pull request if a member of the GitHub CLI team has given the ok after discussion in an issue
17
+
18
+
## Building the project
19
+
20
+
Prerequisites:
21
+
- Go 1.13
22
+
23
+
Build with: `make` or `go build -o bin/gh ./cmd/gh`
24
+
25
+
Run the new binary as: `./bin/gh`
26
+
27
+
Run tests with: `make test` or `go test ./...`
17
28
18
29
## Submitting a pull request
19
30
20
-
0. Clone this repository
21
-
0. Create a new branch: `git checkout -b my-branch-name`
22
-
0. Make your change, add tests, and ensure tests pass
23
-
0. Make a PR: `gh pr create --web`
31
+
1. Create a new branch: `git checkout -b my-branch-name`
32
+
1. Make your change, add tests, and ensure tests pass
33
+
1. Submit a pull request: `gh pr create --web`
24
34
25
35
Contributions to this project are [released][legal] to the public under the [project's open source license][license].
26
36
27
37
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.
28
38
29
-
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.
39
+
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.
0 commit comments