Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 2.16 KB

Contributing to V4-web

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

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

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code, thoroughly test your code locally.
  3. Make sure your code lints.
  4. Issue that pull request!

We use a commit-msg hook to check if your commit messages meet the conventional commit format.

In general the pattern mostly looks like this:

type(scope?): subject #scope is optional; multiple scopes are supported (current delimiter options: "/", "" and ",")

Real world examples can look like this:

chore: run tests on travis ci fix(server): send cors headers feat(blog): add comment section

Common types according to commitlint-config-conventional can be:

build chore ci docs feat fix perf refactor revert style test

Any contributions you make will be under the same License

When you submit code changes, your submissions are understood to be under the same License that covers the project.

Report bugs using Github's issues

Report a bug by opening a new issue.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Attach screenshots or videos
  • 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)