Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.01 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! We welcome contributions from everyone.

Before getting started, please take a moment to review the guidelines outlined below.

How to Contribute

To contribute to this project, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature-branch-name.
  3. Make your changes.
  4. Test your changes thoroughly.
  5. Commit your changes: git commit -m "Descriptive commit message".
  6. Push to your fork: git push origin feature-branch-name.
  7. Create a pull request.

Code Style Guidelines

  • Follow the established coding style and conventions.
  • Write clear and concise code with meaningful variable names and comments when necessary.
  • Ensure your code is well-formatted and adheres to best practices.
  • If you're introducing new functionality, include appropriate tests.

Bug Reports and Feature Requests

If you encounter any bugs or have ideas for new features, please open an issue on GitHub. When opening an issue, provide detailed information about the problem or suggestion, including steps to reproduce for bugs.

Pull Request Guidelines

  • Ensure your pull request addresses a specific issue or adds value to the project.
  • Provide a clear and descriptive title for your pull request.
  • Describe the changes introduced by your pull request in detail.
  • Reference any related issues in your pull request description using the #issue-number format.
  • Ensure your code builds and passes all tests.
  • Keep pull requests focused and avoid making unrelated changes.
  • Be responsive to feedback and address any review comments promptly.

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for your interest in contributing to our project! If you have any questions or need assistance, feel free to reach out to us.