diff --git a/.gitignore b/.gitignore index 7fdd5aac43..59ef6c06c5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ coverage/ node_modules/ pkg/ +.idea/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e32350ade..5f05c44349 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 `` with the name of the account you forked to. +Set up the repository locally. Replace `` with the name of the account you forked to. ```shell git clone https://github.com//auth-oauth-user-client.js.git @@ -41,7 +41,7 @@ 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]`: @@ -49,7 +49,7 @@ You can install `@octokit/auth-oauth-user-client` from each pull request. Replac 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 @@ -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. diff --git a/package.json b/package.json index a7458322c9..9c8d9bdc33 100644 --- a/package.json +++ b/package.json @@ -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"