Skip to content

Commit

Permalink
docs: add "Contributing" section to README.md
Browse files Browse the repository at this point in the history
Issues: #25
  • Loading branch information
geoffreyvanwyk committed Jan 8, 2024
1 parent 707dc31 commit e41ae04
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,21 @@ as `GALAXY_API_KEY`.
When you are ready to publish, add a Git tag to the last commit. The tag name
must start with a `v`.

## Contributing

To contribute to this repository, please use the [Conventional
Commits](https://conventionalcommits.org) convention. It makes it easier to
create change logs for new releases.

The commits are linted using [Commit Lint](https://commitlint.js.org/#/)
whenever a pull request is made.

To have the Commit Lint check your commits locally as a commit-msg hook, run
`npm install` after cloning this repository. If you are using Visual Studio
Code, you can also install the Commit Lint extension recommended by this
repository, to lint your commits as you write them in the Source Control panel
of VS Code.

## License

Copyright &copy; 2023 Geoffrey Bernardo van Wyk (<https://geoffreyvanwyk.dev>)
Expand Down

0 comments on commit e41ae04

Please sign in to comment.