Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 2.34 KB
Raw

Contributing to Grunna

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 Gitlab

We use gitlab to host code, to track issues and feature requests, as well as accept merge requests.

We Use GitFlow, So All Code Changes Happen Through Merge Requests

Merge requests are the best way to propose changes to the codebase (we use Git Flow). We actively welcome your merge requests:

  1. Fork the repo and create your branch from develop.
  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 merge request!

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.

Report bugs using GitLab's issues

We use GitLab issues to track public bugs. Report a bug by opening a new issue; it's that easy! If you want to discuss the issue before you create a new issue you can talk about it in our Discord Code channel

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.

Use a Consistent Coding Style

  • Try to follow what is already done, or if you want to change anything, have a discussion with the main contributers.
  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint for style unification

License

By contributing, you agree that your contributions will be licensed under its MIT License.