Skip to content
This repository was archived by the owner on Jan 14, 2020. It is now read-only.

Update CONTRIBUTING.md #613

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
40 changes: 33 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,40 @@
# Contributing to Origin.js
## Contributing to Origin.js

Thanks for helping out! 👍

Before you summit a PR, you'll want to make sure that:
Like any other open source projects, there are multiple ways to contribute to this project:

1. Any changes are tested.
2. All tests pass. (See each package's readme for instructions on testing that package.)
3. The formatting is correct. Just run `npm run format` in a package folder.
* As a developer, depending on your skills and experience,
* As a user who enjoys the project and wants to help.

If this is a new feature, make sure you've discussed it with [our #engineering channel on Discord](https://www.originprotocol.com/discord).
##### Reporting Bugs

If you found something broken or not working properly, feel free to create an issue in Github with as much information as possible, such as logs and how to reproduce the problem. Before opening the issue, make sure that:

* You have read this documentation,
* You are using the latest version of project,
* You already searched other issues to see if your problem or request was already reported.

##### Improving the Documentation

You can improve this documentation by forking its repository, updating the content and sending a pull request.


#### We ❤️ Pull Requests

A pull request does not need to be a fix for a bug or implementing something new. Software can always be improved, legacy code removed and tests are always welcome!

Please do not be afraid of contributing code, make sure it follows these rules:

* Any changes are tested,
* All tests pass. (See each package's readme for instructions on testing that package.),
* The formatting is correct. Just run `npm run format` in a package folder,
* If this is a new feature, make sure you've discussed it with [our #engineering channel on Discord](https://www.originprotocol.com/discord).
* Your code compiles, does not break any of the existing code in the master branch and does not cause conflicts,
* The code is readable and has comments, that aren’t superfluous or unnecessary,
* An overview or context is provided as body of the Pull Request. It does not need to be too extensive.

Extra points if your code comes with tests!


### Coding style: Javascript
Expand All @@ -17,4 +43,4 @@ We use [NPM style](https://docs.npmjs.com/misc/coding-style), as automated by th

### Coding style: Solidity

We use two space indents. Just copy the surrounding style and use your good judgement.
We use two space indents. Just copy the surrounding style and use your good judgement.