Skip to content

Latest commit

 

History

History
37 lines (21 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

37 lines (21 loc) · 1.11 KB

Contributing

Thanks for checking out IMSCII!

Getting Started

  1. Fork imscii and run npm install within the directory.

  2. On your fork, create a new branch named username/work-description, where username is your GitHub username and work-description is a short description for your contribution.

    For example: mster/new-mode

  3. Commit your work to the branch you created.

  4. 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.

  5. Open a pull request to mster:master.

Code Style

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

Testing

As of v0.0.4, tests consist of:

  • linting using StandardJS

Code of Conduct

TL;DR

Respect others, practice patience, and give constructive criticism.

Need Help

We're happy to help out, no matter how small the problem. Open an issue, ping the author (@mster), comment on a PR.