Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 2.3 KB
Raw

Contributing to Mihon Backup Viewer

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

We Develop with Github

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. Make necessary changes.
  3. Add code comments.
  4. Format your code
  5. Create that pull request!

Formatting your code

Format Commits code style: prettier

  1. Install Node.js
  2. Run npm ci in the repo folder to install Prettier and setup the pre-commit hook
  3. [Optional] Setup prettier on your editor

Any contributions you make will be under the GNU GPLv2 Software License

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

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.
  • Image if it relates to UI
  • 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)

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft