Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 3.09 KB
Raw

Contribution Guidelines

Thank you for considering contributing to our project! We appreciate your interest and support. To ensure a smooth and effective collaboration, please follow these guidelines.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Style Guides
  4. Additional Resources

Code of Conduct

Please read and follow our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue and include the following details:

  • Clear and descriptive title for the issue.
  • Steps to reproduce the issue.
  • Expected behavior versus actual behavior.
  • Screenshots or log files, if applicable.
  • Environment details, such as browser, operating system, and relevant configurations.

Suggesting Enhancements

We welcome feature requests! To suggest an enhancement, please follow these steps:

  1. Check the issue tracker to see if the feature has already been requested.
  2. Open a new issue and provide the following information:
    • Detailed description of the proposed feature.
    • Rationale and benefits of the feature.
    • Examples or mockups, if possible.
    • Any additional context that might help.

Submitting Pull Requests

To submit a pull request, follow these steps:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch from main for your changes (use a descriptive name, e.g., feature/add-new-feature or fix/issue-123).
  3. Make your changes. Ensure your code adheres to the project's style guidelines.
  4. Test your changes thoroughly.
  5. Commit your changes with a clear and concise commit message.
  6. Push your branch to your forked repository.
  7. Open a pull request to the main branch of this repository. Provide a detailed description of your changes and link any related issues.

Style Guides

Code Style

Please adhere to the coding style used in the project. This includes:

  • Descriptive variable and function names.
  • Comments where necessary to explain complex logic.
  • Following language-specific best practices.

Commit Messages

Write clear, concise commit messages. Follow these conventions:

  • Start with a short summary (50 characters or less).
  • Include additional detail in the body, if necessary.
  • Use the imperative mood (e.g., "Add feature" instead of "Added feature").

Additional Resources

We are grateful for your contributions and look forward to collaborating with you!