Skip to content

Commit 351f8c0

Browse files
author
Sebastian Wilgosz
authored
Add CONTRIBUTING.md
1 parent 2d5ce58 commit 351f8c0

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Contributing
2+
3+
Bug reports and pull requests are welcome on GitHub at https://github.com/driggl/jsonapi_errors_handler.
4+
5+
**How to contribute:**
6+
7+
1. Create Issue on Github.
8+
2. Fork repository
9+
3. Install [Rubocop](https://github.com/rubocop-hq/rubocop) - make sure you run it before commiting changes
10+
4. Commit changes
11+
- Keep commits small and atomic
12+
- Start commit message from keywords (Add/Remove/Change/Refactor/Move/Rename/Upgrade/Downgrade)
13+
- Keep commits imperative style
14+
- Mention issue number (i.e "Resolves: #3")
15+
5. Make sure you cover your change with tests.
16+
6. Create Pull Request
17+
18+
**Coding Guidelines**
19+
20+
- We use [Rubocop](https://github.com/rubocop-hq/rubocop) and Ruby style guides for linting `*.rb` files.
21+
- We use [Remark Lint](https://github.com/remarkjs/remark-lint) for linting `*.md` files.

0 commit comments

Comments
 (0)