First of all, welcome and thanks for taking the time to contribute. 👍
This project and everything about it is ruled by our code of conduct. Everyone is expected to follow those simples rules. If you see unacceptable behavior, be sure to report it to guillaume.martigny@gmail.com.
The easiest way to help us, is by reporting anything fishy about Pencil.js with a new issue. But first, be sure to check if it's not already on the list of known bugs.
Following our issue template allow for a better understanding and a quicker resolution.
We are eager to listen to the users, so if you feel like something missing or not working as you expect, you can fill a feature request. As always, take a look first at the list of requests and upvote what you want most.
You want to get your hands dirty ? Good 😉
Here's a few steps to guide you.
You need to fork the repo to make a copy for you. Then you can clone this copy to your machine.
git clone git@github.com:<YOUR_GITHUB_ID>/pencil.js.git
cd pencil.js
npm install
Finally, you'll need to create a new branch to host your modifications. Use a relevant name for your branch (ex: new_heart_component, refacto_all_tests ...).
git checkout -b <YOUR_BRANCH_NAME>
You can then start to make modification to the code. Here's a few useful commands.
To build the project, you can simply run the build script. It will automatically re-build each time you make any change.
npm run play
In the playground Javascript file, you'll find a basic setup script. You can then mess with it to see your modifications in actions.
In order for everyone to work in harmony, we have a few guidelines.
We use eslint to check the code-style with a linting script.
npm run lint
There's a test file for each modules. You can run all the tests with the test script.
npm test
If you've made structural changes, you can build to check that everything is in order.
npm run build
Once you're done editing the code, checking you forget no lint and running the tests successfully, you can create your pull request.
Commit your code, part by part, using meaningful commit message with git.
git commit -m "Some description" file1 file2 ...
When no changes are left, you can push it online.
git push
On your fork at https://github.com/your-name-here/pencil.js, you should see a button to create a new pull request. Once you've clicked it, confirm the committed files and add a clear title and message linking to the issue or feature.
Finally, we'll review your code and eventually give you feedback.
If everything goes well, you'll be an official contributor of pencil.js ! ✌️