Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

59 lines (38 loc) · 2.3 KB

Contributing to Menufic

We 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

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase and we actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. Add tests, if you've added anything that needed needs to be tested.
  3. Ensure that eslint checks and test suites passes.
  4. Issue that pull request!

Use a Consistent Coding Style

  • Let prettier and eslint to take care of the formatting
  • Please make sure to add TSDoc comments wherever necessary
  • Avoid using any as a type
  • Make sure that the code is easily readable and understandable

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Deployment

  • Menufic is deployed via Vercel and new deployments will be manually triggered by maintainers after verifying the changes.

Report bugs using Github's issues

We 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

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • 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)

People love thorough bug reports. I'm not even kidding.

Asking for help

You can either create an issue or even reach me out directly via my personal email [email protected] or LinkedIn for any assistance or clarifications.