Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (30 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.42 KB
Raw

Repository Contributing Guidelines

Welcome to our GitHub repository! We appreciate your interest in contributing to our project. We value the collaborative spirit of the open-source community and would love to have your contributions. This document outlines the guidelines to help you get started. For more detailed information, please refer to our wiki section.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Create a new branch in your forked repository. Choose a descriptive name that summarizes your contribution.
  3. Make the necessary changes or additions to the codebase.
  4. Test your changes thoroughly to ensure they don't introduce any issues.
  5. Commit your changes with a clear and concise commit message.
  6. Push the changes to your forked repository.
  7. Open a pull request (PR) in our repository to propose your changes.

PR Guidelines

When submitting a pull request, please make sure to:

  • Clearly describe the purpose of your PR.
  • Include any relevant information or context that helps us understand your changes.
  • Make sure your changes adhere to our coding style and guidelines.
  • Test your changes thoroughly and provide any necessary documentation or test cases.
  • Ensure your PR does not include any unrelated or unnecessary changes.

Repositorty Wiki

For more in-depth information about our project, development setup, coding conventions, and specific areas where you can contribute, please refer to our wiki section. It contains valuable resources and documentation to help you understand our project better.

We encourage you to explore the wiki before making contributions. It will provide you with the necessary background knowledge and help you find areas where your expertise can make a difference.

Communication

If you have any questions, concerns, or need clarification on anything related to the project or your contributions, feel free to reach out to us. You can use the GitHub issue tracker or the Discussion channels.

Code of Conduct

We expect all contributors to adhere to our code of conduct, which ensures a safe and inclusive environment for everyone. Please review our code of conduct before making contributions.

Thank you for considering contributing to our project! We appreciate your time and effort in making it better.