Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 2.55 KB

Contribution Guidelines - Checkmate

Thank you for your interest in contributing to the Checkmate project! As an open-source initiative, we greatly value contributions from the community. To ensure a smooth and efficient collaboration, please follow the guidelines outlined below.

Before You Contribute

  • Please review the documentation to understand the project’s purpose and structure.
  • Check existing Issues and Pull Requests to avoid duplication.

Ways to Contribute

We welcome contributions in various forms, including but not limited to:

  1. Reporting Issues: If you encounter bugs, or have feature suggestions, please:
    • Search existing Issues to check if the problem has already been reported.
    • If the issue is new, create a detailed GitHub Issue, including:
      • A clear and descriptive title.
      • Steps to reproduce (if applicable).
      • Expected and actual behavior.
      • Any relevant logs, screenshots, or configurations.
  2. Raise Pull Requests: To contribute directly to the codebase
    • Create a new branch, implement your changes, ensuring your code adheres to the project’s standards.
    • Open a Pull Request to propose your changes, providing a detailed description of the update.
    • Update the documantation All PRs undergo review before merging. Engage constructively in discussions and incorporate feedback as needed.

Coding Standards

  • Strive clean, readable, and well-documented code.
  • Write relevant tests to validate new functionality.
  • Use clear and descriptive commit messages.

Testing Guidelines

All contributions must be properly tested to maintain project stability.

Documentation Updates

  • If your contribution introduces new features or modifications, ensure that the relevant documentation is updated.
  • Maintain clarity and completeness in documentation for ease of understanding.

Code Review Process

  • All Pull Requests undergo review by community members before merging.
  • Be open to feedback and engage constructively in discussions.
  • Address requested changes promptly to facilitate timely integration.

Getting Support

  • If you have questions or need clarification on contributing, reach out via the Issue Tracker or Discord.

We appreciate your contributions to Checkmate and look forward to your participation in improving this project! 🚀

Thank you for helping make Checkmate a better platform! 🎉