Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (53 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 2.7 KB

Contributing Guidelines

Thank you for considering contributing to this project! We appreciate your time and effort.

To ensure a smooth collaboration, please follow these guidelines when contributing:

Table of Contents

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes and test them thoroughly.
  5. Commit your changes with descriptive commit messages.
  6. Push your changes to your forked repository.
  7. Submit a pull request to the main repository.

Contributing Process

Please follow these guidelines when contributing:

  • Before starting work on a new feature or bug fix, create an issue to discuss the proposed changes.
  • Follow the coding style and conventions used in the project.
  • Write clear and concise commit messages.
  • Test your changes thoroughly before submitting a pull request.
  • Be respectful and considerate towards other contributors.

Code Style

Please adhere to the following code style guidelines:

  • Use consistent indentation (spaces or tabs).
  • Follow the naming conventions used in the project.
  • Write clear and concise comments.

Bug Reports

If you encounter a bug in the project, please follow these steps to report it:

  1. Check if the bug has already been reported by searching the issue tracker.
  2. If the bug has not been reported, create a new issue.
  3. Provide a clear and concise description of the bug, including steps to reproduce it.
  4. Include any relevant error messages or screenshots.

Feature Requests

If you have an idea for a new feature or improvement, please follow these steps to request it:

  1. Check if the feature has already been requested by searching the issue tracker.
  2. If the feature has not been requested, create a new issue.
  3. Provide a clear and concise description of the feature or improvement.

Pull Requests

We welcome pull requests from contributors. Please follow these steps to submit a pull request:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your changes.
  3. Make your changes and test them thoroughly.
  4. Commit your changes with descriptive commit messages.
  5. Push your changes to your forked repository.
  6. Submit a pull request to the main repository.

License

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