From 8be46a371ad67be181e152e358fbb7448d553f4c Mon Sep 17 00:00:00 2001 From: Gregor Martynus <39992+gr2m@users.noreply.github.com> Date: Mon, 8 Mar 2021 12:52:16 -0800 Subject: [PATCH] docs(CONTRIBUTING): replace `plugin-paginate-rest.js` with `types.ts` thanks @ojab https://github.com/octokit/types.ts/issues/284#issuecomment-793038617 --- CONTRIBUTING.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b2759903..faabafa7c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,10 +7,9 @@ By participating in this project you agree to abide by its terms. Before you create a new Issue: -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. -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 +1. Please make sure there is no [open issue](https://github.com/octokit/types.ts/issues?utf8=%E2%9C%93&q=is%3Aissue) yet. +2. If it is a bug report, include a code snippet to reproduce the issue 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. -4. Please include links to the corresponding github documentation. ## Setup the repository locally @@ -19,8 +18,8 @@ First, fork the repository. Setup the repository locally. Replace `` with the name of the account you forked to. ```shell -git clone https://github.com//plugin-paginate-rest.js.git -cd plugin-paginate-rest.js +git clone https://github.com//types.ts.git +cd types.ts npm install ``` @@ -34,15 +33,9 @@ npm test - Create a new branch locally. - Make your changes in that branch to your fork repository -- Submit a pull request from your topic branch to the master branch on the `octokit/plugin-paginate-rest.js` repository. +- Submit a pull request from your topic branch to the master branch on the `octokit/types.ts` repository. - 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. -## Testing a pull request from github repo locally: - -You can install `@octokit/plugin-paginate-rest` from each pull request. Replace `[PULL REQUEST NUMBER]` - -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` - ## Merging the Pull Request & releasing a new version 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: Only one version number is bumped at a time, the highest version change trumps the others. Besides publishing a new version to npm, semantic-release also creates a git tag and release on GitHub, generates changelogs from the commit messages and puts them into the release notes. -s + If the pull request looks good but does not follow the commit conventions, use the Squash & merge button.