Skip to content

Latest commit

 

History

History
72 lines (55 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

72 lines (55 loc) · 2.68 KB

Contributing to GYM-APP

Thank you for considering to contribute to GYM-APP projects!. It is a pleasure meeting and connecting with you. Here are some guidelines to help you contribute to this project effectively.

Table of Contents

  1. How to Contribute
    • Reporting Bugs
    • Requesting Features
    • Submitting Pull Requests
  2. Development Setup
  3. Style Guidelines
  4. Commit Message Guidelines

How to Contribute

You can contribute to this project by creating issues and pull requests.In case you come across this below,You can follow the guidelines.

Reporting Bugs

  • Before submitting a bug report, check the issue tracker to ensure it hasn't already been reported.
  • If you can't find an issue for your bug, open a new issue.
    • Include details about the environment, steps to reproduce, and expected/actual outcomes.
    • Provide any relevant screenshots or logs.

Requesting Features

  • To request a feature, open a new issue.
    • Provide a clear description of the feature, including its purpose and potential benefits.
    • If possible, describe how it could be implemented.

Submitting Pull Requests

  1. Fork the repository and clone it locally.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes, and ensure they adhere to the Style Guidelines.
  4. Commit your changes following the Commit Message Guidelines.
  5. Push your branch to your fork and open a pull request.
  6. Ensure your pull request passes all tests and is well-documented.

Development Setup

  1. Clone the repository: 
    git clone https://github.com/Aneeshaik/gym-app.git
cd gym-app
  2. Install dependencies: 
    npm install
  3. Run the development server: 
    npm run dev

Style Guidelines

  • Follow the existing code style and structure.
  • Write clean and readable code.
  • Include comments for complex logic.

Commit Message Guidelines

  • Use the present tense ("Add feature" instead of "Added feature").
  • Keep the message concise and descriptive (less than 72 characters).
  • Example:
    • fix: resolve issue with image loading on mobile
    • feat: add ARIA attributes for improved accessibility
    • docs: update README with new installation instructions
    • style: refactor CSS to improve performance and readability
    • refactor: simplify code for better maintainability and scalability