-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(contribute): add CONTRIBUTING.md
- Loading branch information
Raphaël Benitte
committed
Jul 9, 2017
1 parent
c624c06
commit 197ed78
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Contributing to veggies | ||
|
||
Find veggies useful and want to get involved? Thanks! | ||
There are plenty of ways you can help. | ||
|
||
Please take a moment to review this document in order to make | ||
the contribution process easy and effective for everyone involved. | ||
|
||
Following these guidelines helps to communicate that you respect | ||
the time of the developers managing and developing this open source project. | ||
In return, they should reciprocate that respect in addressing your issue or assessing patches and features. | ||
|
||
## Setting Up a Local Copy | ||
|
||
1. Clone the repo with `git clone https://github.com/ekino/veggies` | ||
|
||
2. Run `yarn install` in the root `veggies` folder. | ||
|
||
Once it is done, you can modify any file locally and run `yarn run examples start` or `yarn test` to check it. | ||
|
||
## Submitting a Pull Request | ||
|
||
Good pull requests, such as patches, improvements, and new features, are a fantastic help. | ||
They should remain focused in scope and avoid containing unrelated commits. | ||
|
||
Please **ask first** if somebody else is already working on this or the core developers think your feature is in-scope for veggies. | ||
Generally always have a related issue with discussions for whatever you are including. | ||
|
||
Please also provide a **test plan**, i.e. specify how you verified that your addition works. | ||
|
||
|