Skip to content

Latest commit

 

History

History
57 lines (29 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

57 lines (29 loc) · 2.9 KB

Contributor Guidelines

Issues

Feature Requests

If you have ideas or how to improve our projects, you can suggest features by opening a GitHub issue. Make sure to include details about the feature or change, and describe any uses cases it would enable.

Feature requests will be tagged as [enhancement] and their status will be updated in the comments of the issue.

Bugs

When reporting a bug or unexpected behaviour in a project, make sure your issue describes steps to reproduce the behaviour, including the platform you were using, what steps you took, and any error messages.

Reproducible bugs will be tagged as [bug] and their status will be updated in the comments of the issue.

Wontfix

Issues will be closed and tagged as [wontfix] if we decide that we do not wish to implement it, usually due to being misaligned with the project vision or out of scope. We will comment on the issue with more detailed reasoning.

Contribution Workflow

Open Issues

If you're ready to contribute, new issues click here issues/new/choose

if this repo has opend issues, start by looking at our open issues tagged as help wanted or good first issue.

You can comment on the issue to let others know you're interested in working on it or to ask questions.

Making Changes

  1. Fork the repository.

  2. Create a new feature branch.

  3. Make your changes. Ensure that there are no build errors by running the project with your changes locally.

  4. git commit use https://www.conventionalcommits.org/

  • Can use command tools as: cz-cli

Command + Shift + P or Ctrl + Shift + P enter Conventional Commits or cc , and press Enter

https://plugins.jetbrains.com/files/13389/screenshot_21408.png

  1. Open a pull request with a name and description of what you did. You can read more about working with pull requests on GitHub here.

  2. A maintainer will review your pull request and may ask you to make changes.