Thanks for checking out IMSCII!
-
Fork imscii and run
npm install
within the directory. -
On your fork, create a new branch named
username/work-description
, whereusername
is your GitHub username andwork-description
is a short description for your contribution.For example:
mster/new-mode
-
Commit your work to the branch you created.
-
When you're ready for review or to submit your contribution, make sure your fork is up to date and that your code pases
npm test
. If your fork is out of date, you will need to rebase. -
Open a pull request to
mster:master
.
imscii uses StandardJS. To have your contributions accepted, they must also be in StandardJS style.
To test if your code passes, run the test command:
npm run lint
As of v0.0.4, tests consist of:
- linting using StandardJS
TL;DR
Respect others, practice patience, and give constructive criticism.
We're happy to help out, no matter how small the problem. Open an issue, ping the author (@mster), comment on a PR.