Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (39 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 2.28 KB

Contributing to FastFitHubX

Welcome to the FastFitHubX ecosystem! We're excited to have you here. This guide will help you get started with contributing to our open-source projects.

Development Setup

  1. Fork the Repository: Create a personal fork of the repository on GitHub.
  2. Clone the Fork: Clone your fork to your local machine. 
    git clone https://github.com/YOUR_USERNAME/repository-name.git
  3. Install Dependencies: Follow the instructions in the repository's README.md to install the necessary dependencies.
  4. Create a Branch: Create a new branch for your changes. 
    git checkout -b feature/your-feature-name

Coding Standards

  • Consistency: Follow the existing coding style and patterns in the repository.
  • Linting: Ensure your code passes all lint checks.
  • Testing: Add tests for any new functionality and ensure all existing tests pass.
  • Documentation: Update the documentation if your changes introduce new features or modify existing ones.

Pull Request Workflow

  1. Commit Changes: Commit your changes with a clear and descriptive commit message.
  2. Push to Fork: Push your branch to your fork on GitHub.
  3. Open a Pull Request: Open a pull request from your fork to the main or master branch of the original repository.
  4. Review and Iterate: Participate in the code review process and make any necessary changes.

Issue Reporting

  • Search First: Before opening a new issue, search the existing issues to see if it has already been reported.
  • Use Templates: Use the provided issue templates for bug reports and feature requests.
  • Be Descriptive: Provide as much detail as possible, including steps to reproduce for bugs.

Commit Message Format

We follow a structured commit message format:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, etc.)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries

Example: feat: add anti-cheat logic for Proof-of-Workout

Thank you for contributing to FastFitHubX!