Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 2.64 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to this project! Before you start, please read the following guidelines carefully.

How Can I Contribute?

Reporting Bugs

If you find a bug, follow these steps:

  1. Ensure the bug hasn't already been reported by searching the issues.
  2. If the bug is not reported, open a new issue with a detailed description of the problem, how to reproduce it, and, if possible, relevant screenshots or error messages.

Proposing New Features

If you have an idea for a new feature:

  1. Check if someone has already proposed a similar feature in the issues.
  2. If you don't find anything similar, open a new issue describing your idea and why you think it would be useful.

Improving Documentation

Good documentation is key to the success of any project. You can help by:

  1. Fixing typos or grammatical errors in the existing documentation.
  2. Adding more detailed explanations or examples to help users understand how to use the project.
  3. Creating new documentation for features that are not well covered.

Discussing Changes

Before you start writing code and opening a pull request, please discuss your ideas openly with the community:

  1. Open a new issue or comment on an existing one to describe the changes you plan to make.
  2. Engage in discussion to get feedback and ensure that your contribution aligns with the project's goals and roadmap.

Submitting a Pull Request

If you want to contribute code:

  1. Fork the repository.
  2. Create a new branch with a descriptive name (feature/new-feature or fix/specific-bug).
  3. Make your changes in your branch.
  4. Ensure all tests pass and your changes do not introduce any issues.
  5. Commit your changes following the Conventional Commits guidelines.
  6. Submit a pull request describing the changes and why they are necessary.

Conventional Commits

Please follow the Conventional Commits guidelines for your commit messages. This helps to maintain a consistent commit history. Here are some examples:

  • feat: add new feature
  • fix: correct a bug
  • docs: update documentation
  • style: improve code formatting
  • refactor: code refactoring without functional changes
  • test: add or update tests

Code of Conduct

To ensure a welcoming and respectful environment, all participants must follow our Code of Conduct.

Thank you for your contribution!

If you have any questions or need help, feel free to contact one of the project maintainers.