Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

69 lines (51 loc) · 3.64 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! We appreciate your interest and support. This document provides guidelines for contributing to our project on GitHub. Please take a moment to review this information before getting started.

Table of Contents

Contributing to the Project

We welcome contributions from anyone interested in improving our project. Whether you want to report a bug, suggest a new feature, or submit code changes, your contributions are valuable to us. By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

To contribute to our project, follow these steps:

  • Fork the repository to your GitHub account.
  • Create a new branch for your contribution.
  • Make your changes or additions to the codebase.
  • Test your changes thoroughly.
  • Commit your changes and push them to your forked repository.
  • Submit a pull request (PR) from your branch to our main repository.
  • Provide a descriptive title and include relevant details about your changes in the PR description.
  • Be responsive to feedback and iterate on your changes as needed.

We will review your contribution as soon as possible. Please be patient during this process, as it may take some time for us to respond. We appreciate your understanding and patience.

Bug Reports and Feature Requests

If you encounter a bug in our project or have a specific feature request, please open an issue on our GitHub repository. When submitting an issue, provide as much detail as possible to help us understand the problem or feature request. We will review the issue and respond accordingly.

Code Contribution Guidelines

When submitting code changes, please adhere to the following guidelines:

Follow the style guide mentioned below.

Write clear and concise code with appropriate comments. Test your changes thoroughly before submitting. Ensure that your code does not introduce new bugs or break existing functionality. Provide a comprehensive description of your changes in the pull request.

Commit Guidelines

We follow the conventional commit format for our project. Please structure your commit messages using the following format:

type(scope): subject

body

footer

Where:

  • type: Indicates the type of change (e.g., feat, fix, docs, style, refactor, test, chore).
  • scope: Optional field specifying the scope of the change (e.g., component name, file affected).
  • subject: Brief summary of the change.
  • body: Detailed description of the change (optional).
  • footer: Footer notes, such as references to related issues or PRs (optional).

Style Guide

To maintain consistency throughout the codebase, please adhere to our style guide. The guide provides details on code formatting, naming conventions, and other coding practices. Please refer to the style guide documentation for more information.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. By participating in this project, you are expected to uphold the principles of this code and maintain a respectful and inclusive environment for everyone.

If you encounter any unacceptable behavior, please report it to the project maintainers.

Thank you for your interest in contributing to our project. We appreciate your efforts and look forward to your contributions. Happy coding!