Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (46 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

70 lines (46 loc) · 2.65 KB
Raw

How to Contribute

Fork the project

Fork the project to your GitHub account and clone it to your machine.

Create a branch for your contribution

Create a branch with a meaningful name for your contribution.

Tips:

  • Let's say you want to add a new feature, then you can create a branch with the name feature/new-feature.
  • Let's say you want to fix a bug, then you can create a branch with the name bug/fix-bug.
  • Let's say you want to improve the documentation, then you can create a branch with the name docs/improve-documentation.

Commits and commit messages

Commit conventions and commit messages: Conventional Commits

Tips:

  • Commits should be small and concise.
  • Commits should be written in the imperative, as if giving a command. Example: "Add feature" rather than "Adding feature" or "Added feature".
  • Commits should be written in the present tense, as if it's happening now. Example: "Add feature" rather than "Added feature".
  • Commits should be written in the singular, as if talking about a single thing. Example: "Add feature" rather than "Add features".
  • Commits should be capitalized. Example: "Add feature" rather than "add feature".
  • Commits should end with a period. Example: "Add feature." rather than "Add feature".

Commit message examples

  • feat: add new feature
  • fix: fix bug
  • docs: update documentation
  • style: formatting, missing semicolon; does not affect code
  • refactor: code refactoring
  • perf: improve performance
  • test: add or fix tests
  • chore: update dependencies
  • revert: revert previous commit
  • build: changes that affect the build system or external dependencies (e.g., gulp, broccoli, npm)
  • ci: changes to CI configuration files and scripts (e.g., Travis, Circle, BrowserStack, SauceLabs)

Opening an issue

You should typically open an issue in the following situations:

  • Reporting a bug.
  • Discussing a high-level topic or idea (e.g., community, vision, or policies).
  • Proposing a new feature or other project idea.

If you open an issue to report a bug, please include as many details as possible.

Sending a pull request

You should typically send a pull request in the following situations:

  • Fixing a bug.
  • Adding a new feature.
  • Improving documentation.

If you send a pull request to fix a bug, please include as many details as possible.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you agree to abide by its terms.

License

This project is licensed under the MIT License - see the LICENSE file for more details.