Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 1.43 KB

Contributing

Reporting Issues

If you have found what you think is a bug, please file an issue.

Suggesting new features

If you are here to suggest a feature, first create an issue if it does not already exist. From there, we will discuss use-cases for the feature and then finally discuss how it could be implemented.

Development

If you have been assigned to fix an issue or develop a new feature, please follow these steps to get started:

Commit message conventions

This Project is using Angular Commit Message Conventions.

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Pull requests

Maintainers merge pull requests by squashing all commits and editing the commit message if necessary using the GitHub user interface.

Use an appropriate commit type. Be especially careful with breaking changes.