Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (59 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

71 lines (59 loc) · 3.44 KB

Contributing to Chess Master Ultimate

Thank you for considering contributing to the Chess Master Ultimate project! We welcome contributions from the community to help improve this open-source chess application. This guide outlines how you can contribute effectively.

Code of Conduct

Please review our Code of Conduct to understand the expectations for all contributors and maintain a welcoming environment.

How to Contribute

Reporting Bugs

  • Check the Issues page to ensure the bug hasn't already been reported.
  • Open a new issue with a clear title and description, including steps to reproduce, expected behavior, and actual behavior.
  • Use the bug report template if available.

Suggesting Features

  • Check the Issues page to see if the feature has been proposed.
  • Open a new issue with a clear title and detailed description of the feature, including its purpose and potential implementation.
  • Use the feature request template if available.

Submitting Code Changes

  1. Fork the Repository:
  2. Clone Your Fork: 
    git clone https://github.com/<your-username>/Chess-Master-Ultimate
  3. Create a Feature Branch: 
    git checkout -b feature/your-feature-name
  4. Make Changes:
    • Follow the coding style and conventions used in the project (e.g., TypeScript, Tailwind CSS, Next.js best practices).
    • Ensure your changes are well-documented and include tests if applicable.
  5. Commit Changes:
    • Use clear, descriptive commit messages.
    git commit -m "Add your descriptive message here"
  6. Push to Your Fork: 
    git push origin feature/your-feature-name
  7. Open a Pull Request:
    • Go to the original repository and create a pull request from your branch.
    • Use the Pull Request Template to provide details about your changes.
    • Reference any related issues (e.g., Fixes #123).

Setting Up the Development Environment

  • Follow the Getting Started section in the README.md to set up the project locally.
  • Ensure you have Node.js (v18.0 or higher) and a package manager (npm or yarn) installed.
  • Run npm install or yarn install to install dependencies.
  • Start the development server with npm run dev or yarn dev.

Guidelines

  • Code Quality: Ensure your code is clean, readable, and follows the project's structure.
  • Testing: Add or update tests for new features or bug fixes if applicable.
  • Documentation: Update the README.md or other documentation if your changes affect usage or setup.
  • Security: If you identify a security vulnerability, please follow our Security Policy.

Review Process

  • Pull requests will be reviewed by maintainers as soon as possible.
  • Expect feedback or requests for changes to ensure quality and consistency.
  • Once approved, your changes will be merged into the main branch.

Questions?

If you have questions or need help, feel free to:

Thank you for contributing to Chess Master Ultimate!