Skip to content

Commit d7ab2cd

Browse files
authored
docs(contributing): add explanation on how to manage a merged PR non semantic-release compliant (#2206)
1 parent 590c648 commit d7ab2cd

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Thank you 💖
1212
Before you create a new Issue:
1313

1414
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.
15-
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
15+
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>
1616
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.
1717
4. Please include links to the corresponding GitHub documentation.
1818

@@ -41,7 +41,7 @@ npm test
4141
- Submit a pull request from your topic branch to the main branch on the `octokit/auth-oauth-user-client.js` repository.
4242
- 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.
4343

44-
## Testing a pull request from GitHub repo locally:
44+
## Testing a pull request from GitHub repo locally
4545

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

@@ -69,3 +69,18 @@ on GitHub, generates changelogs from the commit messages and puts them into the
6969
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.
7070

7171
If the pull request looks good but does not follow the commit conventions, use the <kbd>Squash & merge</kbd> button.
72+
73+
> ⚠️ making sure the message is semantic-release compliant before clicking <kbd>Confirm squash and merge</kbd>:
74+
75+
![Screenshot of GitHub's Squash and Merge confirm dialog](assets/squash-and-merge-dialog.png)]
76+
77+
### Troubleshooting
78+
79+
<details>
80+
<summary>What can I do if I <i>squashed and merged</i> with a commit message which is not <a href="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/semantic-release/semantic-release">semantic-release</a> compliant?</summary>
81+
82+
1. After merging, do a follow up on `https://github.com/octokit/<repository name>/actions/workflows/release.yml` to assure your commit is not triggering any release. You can find an example of a commit squashed and merged with a non semantic-release commit message [here](https://github.com/octokit/plugin-throttling.js/runs/5390685684?check_suite_focus=true)
83+
2. Mention (`@username`) the maintainers of the project in your merged _Pull Request_ to let them know there was an issue with your merged _Pull Request_. We need to make sure no _Pull Request_ is merged until this issue is addressed.
84+
3. Open a new _Pull Request_ with an [empty commit](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---allow-empty). In the description, link to the previous merged _Pull Request_ to give context to the reviewers and request a Review from the maintainers. This time make sure the message is [semantic-release](https://github.com/semantic-release/semantic-release) compliant.
85+
86+
</details>

assets/squash-and-merge-dialog.png

16.4 KB
Loading

0 commit comments

Comments
 (0)