Skip to content

Commit

Permalink
Change CONTRIBUTING file based on review feedback
Browse files Browse the repository at this point in the history
- Make footnote markers a link to the footnotes section
- Mention that either generate command needs to be run from the project root
- Mention that the `.sh` script required BASH to run
- Fix Code of Conduct link
  • Loading branch information
Potherca committed Jan 31, 2021
1 parent 4d0dc88 commit a9990e9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Expand Up @@ -4,7 +4,7 @@ When contributing to this repository, please first discuss the change you wish
to make via issue, email, or any other method with the owners of this repository
before making a change.

Please note we have [a code of conduct][code-of-conduct], please follow it in all your interactions
Please note we have [a code of conduct](#code-of-conduct), please follow it in all your interactions
with the project.

## Issues and feature requests
Expand All @@ -29,7 +29,7 @@ Even better: You could submit a pull request with a fix / new feature!

To make it possible to automatically generate a changelog, all tickets/issues must have a milestone and at least one label.

A changelog can be generated using the [`github-changelog-generator`][github-changelog-generator].<sup>(1)</sup>
A changelog can be generated using the [`github-changelog-generator`][github-changelog-generator].[<sup>(1)</sup>](#footnotes)

Our release versions follow [Semantic Versioning][semver].

Expand All @@ -43,7 +43,7 @@ To create a new release:

3. Move any open tickets to the next milestone (create a new one if needed).

4. Generate a changelog:<sup>(2)</sup>
4. Generate a changelog by running `github_changelog_generator` in the project root:[<sup>(2)</sup>](#footnotes)
```
github_changelog_generator --future-release "${sVersion}" --header --output --unreleased-only 2>/dev/null
```
Expand Down Expand Up @@ -132,7 +132,7 @@ version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
1. All settings needed for the changelog-generator are set in `.github_changelog_generator` file.

2. A convenience script is present at `bin/generate-changelog.sh` that will install the changelog-generator, if it is not present, and run the appropriate `github_changelog_generator` command.
The script requires BASH to run. It should be run from the project root, similar to `github_changelog_generator`.

[code-of-conduct]: CODE-OF-CONDUCT.md
[github-changelog-generator]: https://github.com/github-changelog-generator/github-changelog-generator/
[semver]: https://semver.org/

0 comments on commit a9990e9

Please sign in to comment.