Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing guidelines #60

Merged
merged 1 commit into from
Feb 12, 2024
+31 −3
Merged

Update contributing guidelines #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
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 .
```
Loading