Skip to content

Latest commit

聽

History

History
33 lines (24 loc) 路 1.37 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) 路 1.37 KB
Raw

First of all, thank you for taking time to contribute!

This is a non exhaustive guide for contributing to this project, and you can contribute to this document also.

Creating issues

  1. Describe your issue in the title
  2. Is this a bug?
  3. Copy the error messages
  4. Describe the steps to reproduce
  5. Inform your navigator (navigator.userAgent in the browser console)
  6. Inform every other thing that could help solving the issue
  7. Are you going to fix it or someone else can take it?
  8. Is this a feature request?
  9. Describe why is this needed

Creating pull requests

  • Every pull request should reference an issue, this way everyone can discuss and contribute before writing any code and possibly spending time.
  • Describe what your pull request does succintly in the title and give more details in the body.
  • Restrict yourself to changing only related code, ex: don't change a CSS alignment if you are coding a fix in the tooltip rendering. You should create another issue and pull request in this case.
  • Run npm run build before pulling

Git commit messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Styleguide

Refer to the eslint configuration file.