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: CONTRIBUTING.md
+6-13Lines changed: 6 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,9 @@ By participating in this project you agree to abide by its terms.
7
7
8
8
Before you create a new Issue:
9
9
10
-
1. Please make sure there is no [open issue](https://github.com/octokit/plugin-paginate-rest/issues?utf8=%E2%9C%93&q=is%3Aissue) yet.
11
-
2. If it is a bug report, include the steps to reproduce the issue and please create a reproducible test case on [runkit.com](https://runkit.com/). Example: https://runkit.com/gr2m/5aa034f1440b420012a6eebf
10
+
1. Please make sure there is no [open issue](https://github.com/octokit/types.ts/issues?utf8=%E2%9C%93&q=is%3Aissue) yet.
11
+
2. If it is a bug report, include a code snippet to reproduce the issue
12
12
3. If it is a feature request, please share the motivation for the new feature, what alternatives you tried, and how you would implement it.
13
-
4. Please include links to the corresponding github documentation.
14
13
15
14
## Setup the repository locally
16
15
@@ -19,8 +18,8 @@ First, fork the repository.
19
18
Setup the repository locally. Replace `<your account name>` with the name of the account you forked to.
- Make your changes in that branch to your fork repository
37
-
- Submit a pull request from your topic branch to the master branch on the `octokit/plugin-paginate-rest.js` repository.
36
+
- Submit a pull request from your topic branch to the master branch on the `octokit/types.ts` repository.
38
37
- Be sure to tag any issues your pull request is taking care of / contributing to. Adding "Closes #123" to a pull request description will automatically close the issue once the pull request is merged in.
39
38
40
-
## Testing a pull request from github repo locally:
41
-
42
-
You can install `@octokit/plugin-paginate-rest` from each pull request. Replace `[PULL REQUEST NUMBER]`
43
-
44
-
Once you are done testing, you can revert back to the default module `@octokit/plugin-paginate-rest` from npm with `npm install @octokit/plugin-paginate-rest`
45
-
46
39
## Merging the Pull Request & releasing a new version
47
40
48
41
Releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release).
@@ -55,5 +48,5 @@ The following commit message conventions determine which version is released:
55
48
Only one version number is bumped at a time, the highest version change trumps the others.
56
49
Besides publishing a new version to npm, semantic-release also creates a git tag and release
57
50
on GitHub, generates changelogs from the commit messages and puts them into the release notes.
58
-
s
51
+
59
52
If the pull request looks good but does not follow the commit conventions, use the <kbd>Squash & merge</kbd> button.
0 commit comments