Skip to content

Commit 8be46a3

Browse files
authored
docs(CONTRIBUTING): replace plugin-paginate-rest.js with types.ts
thanks @ojab #284 (comment)
1 parent 7fd894f commit 8be46a3

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@ By participating in this project you agree to abide by its terms.
77

88
Before you create a new Issue:
99

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
1212
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.
1413

1514
## Setup the repository locally
1615

@@ -19,8 +18,8 @@ First, fork the repository.
1918
Setup the repository locally. Replace `<your account name>` with the name of the account you forked to.
2019

2120
```shell
22-
git clone https://github.com/<your account name>/plugin-paginate-rest.js.git
23-
cd plugin-paginate-rest.js
21+
git clone https://github.com/<your account name>/types.ts.git
22+
cd types.ts
2423
npm install
2524
```
2625

@@ -34,15 +33,9 @@ npm test
3433

3534
- Create a new branch locally.
3635
- 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.
3837
- 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.
3938

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-
4639
## Merging the Pull Request & releasing a new version
4740

4841
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:
5548
Only one version number is bumped at a time, the highest version change trumps the others.
5649
Besides publishing a new version to npm, semantic-release also creates a git tag and release
5750
on GitHub, generates changelogs from the commit messages and puts them into the release notes.
58-
s
51+
5952
If the pull request looks good but does not follow the commit conventions, use the <kbd>Squash & merge</kbd> button.

0 commit comments

Comments
 (0)