Skip to content

Commit b4ed894

Browse files
committed
docs(contribute): adds contribute guidelines
1 parent cefeb01 commit b4ed894

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
3+
Thank you in advance for contributing to this project.
4+
5+
Here is how I go about contributing to this project. They're all required, unless otherwised indicated via a quote.
6+
7+
## Workflow
8+
9+
We use `husky` with other tools to ensure the guidelines are met.
10+
The only thing we can't check is if you're repo is up to date.
11+
12+
At a high level, this is what is required:
13+
14+
- Fork this repository and clone it onto your machine.
15+
- Make your changes on a per commit basis. One bug/feature/docs change per commit.
16+
- Add commits using `yarn commit` instead of `git commit` to ensure you're commits are formatted correctly
17+
- Adds tests if applicable
18+
- Unit tests via jest
19+
- Browser tests via Cypress
20+
- Tests will be ran on pull and on push.
21+
22+
### Developing
23+
24+
> We recommend using the GitHub CLI, so use `gh repo fork waynevanson/react-sortablejs` and accepting the prompts.
25+
>
26+
> We also recommend using ssh. If you know you use SSH, run `gh config set git_protocol ssh`.
27+
> This allows you use gh cli without having to login every time.

0 commit comments

Comments
 (0)