Skip to content

Latest commit

 

History

History
79 lines (48 loc) · 2.87 KB

contributing.md

File metadata and controls

79 lines (48 loc) · 2.87 KB
Raw

Contribution Guidelines

Thank you for considering contributing to this project! We appreciate your support and are excited to collaborate with you. To ensure a smooth and efficient collaboration process, please follow these guidelines.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue in the issue tracker. Before reporting, please check if the issue has already been reported. When reporting a bug, include:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant screenshots or logs.

Suggesting Enhancements

If you have an idea for an enhancement, please suggest it by opening an issue in the issue tracker. Before suggesting, please check if the enhancement has already been proposed. When suggesting an enhancement, include:

  • A clear and descriptive title.
  • A detailed description of the enhancement.
  • Any benefits or improvements it would bring.

Submitting Pull Requests

If you'd like to contribute code, please follow these steps:

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository on your GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/your-username/repository-name.git

  3. Create a Branch: Create a new branch for your changes.

    git checkout -b feature-branch-name

  4. Make Changes: Make your changes to the codebase.

  5. Commit Changes: Commit your changes with a clear and concise commit message.

    git add .
git commit -m "Description of your changes"

  6. Push to Fork: Push your changes to your forked repository.

    git push origin feature-branch-name

  7. Open a Pull Request: Open a pull request from your forked repository to the main repository. Provide a clear and descriptive title and description of your changes.

Code Style

To maintain a consistent codebase, please adhere to the following coding standards:

  • Follow the existing code style and conventions.
  • Write clear and concise comments where necessary.
  • Ensure your code is well-documented.

Review Process

All submissions will be reviewed by the project maintainers. Feedback will be provided, and changes may be requested. Please be responsive to feedback and make the necessary updates to your submission.

License

By contributing to this project, you agree that your contributions will be licensed under the Apache 2.0 License.

Code of Conduct

Please note that this project is governed by a Code of Conduct. By participating, you are expected to adhere to this code.

Thank you for contributing! We appreciate your efforts and look forward to working with you.