Skip to content

Commit

Permalink
Change markdown formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
wesnel committed Dec 7, 2023
1 parent aaed7d8 commit e037e93
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#### Issues
# Issues

- Bug reports and feature requests for this project should be posted on its GitHub Issues page [here](https://github.com/wesnel/elsewhere/issues).
- The issue template will guide you as you write your issue. Please fill out as much detail as you can.

#### Code contributions
# Code contributions

- Code contributions for this project should come through GitHub pull requests [here](https://github.com/wesnel/elsewhere/pulls).
- The pull request template will guide you as you write your pull request description. It also contains a checklist that will help you ensure that your pull request is ready for approval.
13 changes: 10 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,24 +55,31 @@ The version numbering scheme should follow [semantic versioning](https://semver.

## Changelog

- [ ] Add one or more bullet points under the `[Unreleased] [Unreleased]` level 2 header on line 8 of `CHANGELOG.md` containing a brief summary of your changes. Each of these bullet points should be underneath a level 3 header of `Added`, `Removed`, `Changed`, or `Fixed` --- whichever most appropriately categorizes that bullet point.
- [ ] Add one or more bullet points under the `[Unreleased]` level 2 header on line 8 of `CHANGELOG.md` containing a brief summary of your changes.

Each of these bullet points should be underneath a level 3 header of `Added`, `Removed`, `Changed`, or `Fixed` --- whichever most appropriately categorizes that bullet point.

<!--
The remainder of this "Changelog" section is mostly for maintainers.
-->

If this pull request will result in a new version-numbered release (see the "Version numbers" section above), then also do the following:

- [ ] Add a new level 2 header to `CHANGELOG.md` just above the header of most recent previous version-numbered release. The header should follow the following format, where `version_number` is your new version number from the "Version numbers" section above and `date` is today's date.
- [ ] Add a new level 2 header to `CHANGELOG.md` just above the header of most recent previous version-numbered release. The header should follow the following format, where `version_number` is your new version number from the "Version numbers" section above:

```
[${version_number} - ${date}] [${version_number}]
[${version_number}]
```

- [ ] Move all unreleased changes under the `[Unreleased]` header on line 8 of `CHANGELOG.md` to instead be under your new header from the previous step.
- [ ] Near the bottom of `CHANGELOG.md`, underneath the line which begins with `[Unreleased]:` add a line which follows the following format, where `version_number` is the same as the previous step and `previous_version_number` is the most recent version number prior to your new one:

```
[${version_number}]: https://github.com/wesnel/elsewhere/compare/v${previous_version_number}...v${version_number}
```

- [ ] Near the bottom of `CHANGELOG.md`, edit the line which begins with `[Unreleased]:` to contain your new `version_number` from the previous step:

```
[Unreleased]: https://github.com/wesnel/elsewhere/compare/v${version_number}...HEAD
```

0 comments on commit e037e93

Please sign in to comment.