Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.79 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! We welcome contributions from everyone, regardless of your experience level or background.

Ways to Contribute

Here are some ways you can contribute to the project:

  1. Reporting Bugs: If you find any bugs or issues, please report them by opening a GitHub issue. Be sure to include as much detail as possible to help us understand and reproduce the problem.

  2. Suggesting Enhancements: If you have ideas for new features or improvements, feel free to suggest them by opening a GitHub issue. We appreciate your feedback!

  3. Code Contributions: If you're comfortable with coding, you can contribute directly to the project by submitting pull requests. Please follow the guidelines outlined below when submitting code contributions.

Code Contribution Guidelines

  1. Fork the repository and clone it locally.
  2. Create a new branch for your feature or bug fix: git checkout -b feature-branch-name.
  3. Make your changes and test thoroughly.
  4. Commit your changes with clear and descriptive commit messages.
  5. Push your branch to your fork: git push origin feature-branch-name.
  6. Open a pull request against the main repository's main branch.
  7. Ensure that your pull request description clearly explains the problem you're solving and the approach you've taken.
  8. Be responsive to any feedback or questions during the review process.

Code Style

In this project, we enforce a standardized code style using Prettier and ESLint. These tools help ensure consistency and quality throughout the codebase, promoting readability and maintaining best practices.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License. See the LICENSE file for more details.