Skip to content

Commit

Permalink
Update contributing guidelines
Browse files Browse the repository at this point in the history
Closes #27
  • Loading branch information
baynezy committed Feb 12, 2024
1 parent 5f27858 commit 608f1cf
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
##Contributing##
###Pull Requests###
After forking the repository please create a pull request before creating the fix. This way we can talk about how the fix will be implemeted. This will greatly increase your chance of your patch getting merged into the code base.
# Contributing

## Pull Requests

After forking the repository please create a pull request before creating the fix. This way we can talk about how the
fix will be implemented. This will greatly increase your chance of your patch getting merged into the code base.

## Commit Template

Please run the following to make sure you commit messages conform to the project
standards.

```bash
git config --local commit.template .gitmessage
```

## Markdown

There are linting rules for the markdown documentation in this project. So
please adhere to them. This can be achieved by installing the node module
`markdownlint-cli`.

```bash
npm install -g markdownlint-cli
```

Then to check your Markdown run.

```bash
markdownlint .
```

0 comments on commit 608f1cf

Please sign in to comment.