Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (35 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 2.3 KB
Raw

Contributing

We welcome contributions from the community! Whether you're fixing a bug, adding a new feature, or improving documentation, your help is appreciated. Here are some guidelines to help you get started:

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Clone the Forked Repository: Clone your forked repository to your local machine using: 
    git clone <YOUR_FORKED_REPO_URL>
  3. Create a New Branch: Create a new branch for your changes: 
    git checkout -b <YOUR_BRANCH_NAME>
  4. Make Changes: Make your changes to the codebase. Ensure your code follows the project's coding standards and includes appropriate tests.
  5. Commit Your Changes: Commit your changes with a descriptive message: 
    git commit -m "Description of your changes"
  6. Push to Your Forked Repository: Push your changes to your forked repository: 
    git push origin <YOUR_BRANCH_NAME>
  7. Create a Pull Request: Go to the original repository and create a pull request from your forked repository's branch.

Translating

This project have multilingual support, if you want to help translating the documentation or the website content, please refer to the Translation Guide for more details.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please read it to understand the expectations for behavior within this community.

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue in the GitHub Issues section of the repository. Provide as much detail as possible to help us understand and address the issue.

Please ensure your issue is not a duplicate by searching existing issues before creating a new one, and use clear and descriptive titles and labels. You can follow the self checklist in the issue template to provide all necessary information and check whether your issue meets the contribution guidelines.

License

This project is licensed under the MIT License.

Thank you for considering contributing to this project! Your efforts help make it better for everyone.