Skip to content

Latest commit

 

History

History
122 lines (78 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

122 lines (78 loc) · 3.51 KB

Contributing to TournaMate

First off, thank you for considering contributing to this project! Your time and effort are greatly appreciated.

The following is a set of guidelines to help you contribute effectively to the project. Please adhere to these guidelines to make the contribution process smooth and efficient for everyone involved.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Development Setup
  4. Coding Guidelines
  5. Testing

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How to Contribute

Reporting Bugs

If you encounter a bug in the project, feel free to open a bug report. Please include the following details:

  • A clear description of the issue.
  • Steps to reproduce the bug.
  • Information about your environment (OS, browser, Next.js version, etc.).
  • Screenshots, if applicable.

Suggesting Features

If you have an idea for a new feature, we’d love to hear about it! Open a feature request and provide:

  • A description of the feature.
  • The problem it solves or the value it adds.
  • Any alternatives or related features.

Creating Pull Requests

When making a contribution through a pull request (PR):

  1. Fork the repository and create your branch from main.
  2. Run the tests to ensure your changes do not break existing code.
  3. Create your pull request with the following in mind:
    • Include a clear description of what the PR changes.
    • Reference the issue number your PR is related to (if applicable).
    • Ensure that your changes follow the Coding Guidelines.
  4. Be sure to fill out the provided PR template thoroughly.

Development Setup

  1. Clone the repository:

    git clone https://github.com/asyrafnorafandi/tournamate.git
cd tournamate

  2. Install dependencies:

    npm install

  3. Run the development server:

    npm run dev

  4. Open your browser and navigate to http://localhost:3000 to see your changes live.

Coding Guidelines

To ensure consistency across the codebase, please adhere to the following standards:

  • Code Formatting: This project uses Prettier for code formatting. You can run the following command to format your code:

    npm run format

  • Linting: Before pushing changes, ensure your code passes linting:

    npm run lint

  • Commit Messages: Follow Conventional Commits for commit messages. For example:

    • fix: resolve navbar alignment issue
    • feat: add user authentication

Testing

Please make sure all tests pass before submitting a PR. If you add new functionality, include corresponding unit/integration tests.

  • Run Tests:

    npm test

  • End-to-End Testing: If applicable, ensure your changes work across various environments by adding E2E tests.

Thank you again for your contribution! If you have any questions, feel free to open an issue or reach out to [email protected].