Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.31 KB

Contributing to json-base

I love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

I actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Report bugs using Github's issues

I use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

  • A quick summary and/or background
  • Steps to reproduce
  • Be specific!
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

⚠️ Run yarn lepper:describe in order to get description of how folders are structured ⚠️ ⚠️ Also make sure that the command yarn lepper:verify shows no undescribed folder in case you've added new directories ⚠️