Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.33 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project! We welcome contributions from everyone. By participating in this project, you agree to abide by the Code of Conduct. We appreciate your effort in helping us create an inclusive and welcoming community.

Ways to Contribute

There are several ways you can contribute to this project:

  • Report Issues: If you come across any bugs, issues, or have feature requests, please submit them through our Issue Tracker.

  • Submit Pull Requests: If you have code changes or enhancements to contribute, please submit a pull request. Make sure to follow our coding conventions and provide a clear explanation of your changes.

Getting Started

To get started with contributing, follow these steps:

  1. Fork the repository and clone it locally.
  2. Create a new branch for your contributions. Use the following naming conventions:
    • For adding a new feature/tool, use the prefix feat in the branch name.
    • For platform changes, use the prefix platform.
    • For bug fixes, use the prefix fix.
    • For changing code for performance or convenience purpose (e.g. readability), use the prefix refactor.
    • For writing documentation, formatting etc. use the prefix chore. For example, feat/new-feature or fix/bug-fix.
  3. Make your changes, following our coding conventions and guidelines.
    • When adding a new feature/tool, ensure that you reference it in the tool.js file.
  4. Test your changes thoroughly.
  5. Commit your changes and push them to your fork.
  6. Submit a pull request, explaining the purpose and details of your changes.

Coding Conventions

  • Follow the existing code style and naming conventions used in the project.
  • Write clear and concise code with proper documentation.
  • Ensure your code builds successfully.

Code of Conduct

Please review and adhere to our Code of Conduct in all your interactions and contributions.

Feedback and Communication

We value your feedback and welcome any suggestions or questions you may have. Feel free to join our Community Forum to engage in discussions or reach out to our team.

Thank you for your contribution!