Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
coverage/
node_modules/
pkg/
.idea/
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Thank you 💖
Before you create a new Issue:

1. Please make sure there is no [open issue](https://github.com/octokit/auth-oauth-user-client.js/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/octokit-rest-js-1808
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/octokit-rest-js-1808
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.
4. Please include links to the corresponding GitHub documentation.

## Setup the repository locally
## Set up the repository locally

First, fork the repository.

Setup the repository locally. Replace `<your account name>` with the name of the account you forked to.
Set up the repository locally. Replace `<your account name>` with the name of the account you forked to.

```shell
git clone https://github.com/<your account name>/auth-oauth-user-client.js.git
Expand All @@ -41,15 +41,15 @@ npm test
- Submit a pull request from your topic branch to the main branch on the `octokit/auth-oauth-user-client.js` 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:
## Testing a pull request from GitHub repo locally:

You can install `@octokit/auth-oauth-user-client` from each pull request. Replace `[PULL REQUEST NUMBER]`:

```
npm install https://github.pika.dev/octokit/auth-oauth-user-client.js/pr/[PULL REQUEST NUMBER]
```

Once you are done testing, you can revert back to the default module `@octokit/auth-oauth-user-client` from npm with `npm install @octokit/auth-oauth-user-client`
Once you are done testing, you can revert to the default module `@octokit/auth-oauth-user-client` from npm with `npm install @octokit/auth-oauth-user-client`

## Maintainers only

Expand All @@ -63,7 +63,7 @@ The following commit message conventions determine which version is released:
3. `BREAKING CHANGE:` in body: bumps breaking version, e.g. `1.2.3` → `2.0.0`

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

Before the publish it runs the `npm run build` script which creates a `pkg/` folder with distributions for browsers, node and Typescript definitions. The contents of the `pkg/` folder are published to the npm registry.
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
"license": "MIT",
"scripts": {
"build": "pika build",
"lint": "prettier --check '{src,test}/**/*.{js,json,ts}' '*.{md,json}'",
"lint:fix": "prettier --write '{src,test}/**/*.{js,json,ts}' '*.{md,json}'",
"lint": "prettier --check \"{src,test}/**/*.{js,json,ts}\" \"*.{md,json}\"",
"lint:fix": "prettier --write \"{src,test}/**/*.{js,json,ts}\" \"*.{md,json}\"",
"pretest": "npm run -s lint",
"test": "jest --coverage",
"test:typescript": "npx tsc --noEmit --declaration --noUnusedLocals --esModuleInterop --strict test/typescript-validate.ts"
Expand Down