Skip to content

Latest commit

Β 

History

History
28 lines (19 loc) Β· 1.23 KB

CONTRIBUTING.md

File metadata and controls

28 lines (19 loc) Β· 1.23 KB

Contributing

Want to contribute to hippotable? That makes me very happy ❀️

Here's how to proceed:

  1. See a rough outline of the features we'd like to add in ROADMAP.md β€” in no particular order.
  2. Please find or create an issue before starting the work to make sure nobody's working on the feature already, and to get more context on the problem.
  3. The changes go straight to production, so please take your time to double-check that the code works.
  4. Pull requests should link to the issue (closes #123) and contain a brief description of the technical details of your solution.
  5. I might be busy with other things. If the PR gets stuck, please ping @thoughtspile

Looking forward to your submissions!

Development setup

The repo uses a basic node-based setup. To get started, clone the repo and run:

npm ci
npm run dev

Here are a few links to help you give you a head start: