Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 1.63 KB
Raw

Contributing to Sunglasses projects

We would love for you to contribute to Sunglasses projects and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Code of Conduct

Help us keep Alwatr projects open and inclusive. Please read and follow our Code of Conduct.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. After accepted issue, if you would like to implement the feature, you can submit a Pull Request.

Commit Message Format

<type>(<scope>): <short summary>
  │      │         │
  │      │         └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │      │
  │      └─⫸ Commit Scope: PackageName|Concept (optional)
  │
  └─⫸ Commit Type: fix|feat|refactor|perf|docs|lint|chore|merge|release

Example: feat(signal): support signal providers

Type

Must be one of the following:

  • fix: A bug fix
  • feat: A new feature
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • docs: Documentation only changes
  • lint: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, lint rules, etc)
  • chore: Other changes that don't modify src
  • merge: Merge branches, solve conflict, etc
  • release: Release new version