Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 2.44 KB

CONTRIBUTING.MD

File metadata and controls

44 lines (26 loc) · 2.44 KB
Raw

Contribution Guidelines

Thank you for considering contributing to this project! We appreciate your efforts to make it better.

To contribute to this project, please follow these guidelines:

Table of Contents

Reporting Issues

If you encounter any problems or bugs while using this project, please report them by opening a GitHub issue. Before creating a new issue, please check if a similar one already exists to avoid duplicates. When reporting issues, provide a clear and concise description of the problem, including steps to reproduce it, expected behavior, and any relevant screenshots or error messages.

Feature Requests

If you have ideas for new features or improvements, you can submit a GitHub issue as well. Clearly describe the feature or improvement you would like to see and provide any additional context or examples that might be helpful. Feature requests help us understand your needs and prioritize the project's development.

Submitting Changes

To contribute code changes, follow these steps:

  1. Fork the repository and create a new branch for your changes.
  2. Ensure that your code follows the project's coding conventions and style guide.
  3. Make commits with clear and descriptive messages. Each commit should have a single logical purpose.
  4. Push your branch to your forked repository.
  5. Open a pull request (PR) from your branch to the original repository's main branch.
  6. Provide a detailed description of your changes in the PR, including any related issues or feature requests.

A project maintainer will review your PR, provide feedback if necessary, and merge it once it meets the project's standards.

Coding Conventions

Please adhere to the existing coding conventions and style guide used in this project. Consistent coding styles improve code readability and maintainability. If you're unsure about any aspect of the coding conventions, feel free to ask for clarification in your PR.

Documentation

Improvements to documentation are always welcome. If you find any inaccuracies, missing information, or have suggestions for improving the documentation, you can contribute by submitting a PR with your changes. Make sure to clearly explain the purpose of the documentation update and provide relevant examples, if applicable.