Skip to content

Commit

Permalink
add getting started to contributing.md (#179)
Browse files Browse the repository at this point in the history
  • Loading branch information
veewee authored Apr 9, 2021
1 parent 963a0bb commit 0753087
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,21 @@ We use GitHub issues to track issues within PSL.

Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

## Getting started

Contributing to open-source can be scary. Don't be afraid!
We are looking forward working together to improve this package!

Here is a small checklist to get you going:

- Discuss the changes you want to make first!
- Create a fork of this repository.
- Clone your own repository.
- Run `make install` to get everything set-up for you.
- Checkout a new branch and make the changes you want to make.
- Run `make check` to verify your code is ok to submit.
- Submit your Pull Request.

## Submitting Pull Requests

Before we can merge your Pull-Request here are some guidelines that you need to follow.
Expand Down

0 comments on commit 0753087

Please sign in to comment.