Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 2.47 KB

Contributing

We welcome contributions from the community! To ensure a smooth process, please follow these standard guidelines when contributing to this project:

Submitting Issues

  1. Search Existing Issues: Before submitting a new issue, please check if it has already been reported.
  2. Provide Details: When creating an issue, include as much detail as possible. Describe the problem, steps to reproduce it, and any relevant context or screenshots.

Proposing Enhancements

  1. Search Existing Proposals: Check if the enhancement has already been suggested.
  2. Describe the Enhancement: Clearly explain the proposed enhancement and why it would be beneficial. Include examples or use cases if possible.

Contributing Code

  1. Fork the Repository: Create a fork of the repository to work on your changes.
  2. Create a Branch: Use a descriptive branch name that clearly states the purpose of your changes (e.g., fix-issue-123, add-new-feature).
  3. Make Changes: Implement your changes, ensuring that your code adheres to the project's coding standards and guidelines.
  4. Write Tests: If applicable, add tests for your changes to ensure they work correctly and do not break existing functionality.
  5. Commit Your Changes: Write clear and concise commit messages that explain the purpose of your changes.
  6. Push to Your Fork: Push your changes to your forked repository.
  7. Create a Pull Request: Submit a pull request to the original repository. Provide a detailed description of your changes, including any relevant issue numbers.

Review Process

  1. Code Review: Your pull request will be reviewed by project maintainers. They may request changes or ask for additional information.
  2. Respond to Feedback: Address any feedback or changes requested by the maintainers in a timely manner.
  3. Approval and Merge: Once your changes have been approved, they will be merged into the main branch.

Coding Standards

  • Write Clear Comments: Use comments to explain complex or non-obvious parts of your code.
  • Update Documentation: If your changes affect the project's documentation, update it accordingly.

Additional Notes

  • Be Respectful: Treat other contributors and maintainers with respect. We value a welcoming and inclusive community.
  • Stay Updated: Keep your fork and branch up to date with the latest changes from the main repository.

Thank you for contributing to our project! Your efforts help make it better for everyone.