Skip to content
This repository has been archived by the owner on Sep 28, 2018. It is now read-only.

Latest commit

 

History

History
29 lines (24 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

29 lines (24 loc) · 1.55 KB
Raw

  • Code of Conduct

  • We assume a UNIX-like environment.

    • If it's broken on your Mac/BSD/Linux, please raise an issue, and I'll try to get that fixed ASAP.
    • If it's broken on your Windows machine, please raise an issue, but also consider a PR, because it won't be a priority.

  • Bugs? Please file them! But first, please make sure they're a part of our app, not your environment.

    • Are you on a POSIX-ish OS?
    • Do you have Node installed?
    • Have you run npm i?
    • Are you running npm start (or npm run dev)?
    • If yes, please file a an issue! And if you have the time & ability, please consider helping debug this.

  • Things we need:

    • A lot.
    • Top priorities are here
    • Line endings, etc., as specified here
    • We'd like to stick to this style, but sometimes we're not so good at this.
      • 2 spaces, comma first, semicolon-free, keep things lined up, and a bunch of other things.
      • It's all pretty evident just from reading the code.

  • Please, work on a named feature branch on your fork! It makes things a lot easier on us.

  • Please, in PRs, include details.

    • (Doesn't have to be all that detailed, but some info definitely helps.)

  • Commit Messages

  • That's all! Really, thanks for wanting to contribute, I appreciate every little bit. You're great.