Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (83 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

116 lines (83 loc) · 3.3 KB
Raw

How to Contribute

Shuemo is a collaborative project, and we welcome contributions from everyone. This guide will help you understand how to contribute.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand what actions will and will not be tolerated.

Reporting Bugs

If you find a bug, please open an issue on GitHub with:

  • A clear and descriptive title
  • A detailed description of the issue
  • Steps to reproduce the issue
  • Any relevant logs, screenshots, or error messages

Suggesting Enhancements

If you have an idea for an enhancement, please open an issue on GitHub and include:

  • A clear and descriptive title
  • A detailed description of the enhancement
  • The motivation and benefits for the enhancement
  • Any examples or mockups if applicable

Development Workflow

  1. Clone the repository:

    git clone https://github.com/0spol/shuemo.git

  2. Navigate to the project directory:

    cd shuemo

  3. Run in Docker:

    docker compose up

  4. Inject Spring/demo.sql in the database:

Development Workflow without Docker

  • Change IPs

Run FrontEnd: cd React npm install npm run dev

Run BackEnd: cd Spring

  • Run whit maven
  • Inject Spring/demo.sql

Code Style

Please follow these guidelines to keep the codebase clean and readable:

  • Use meaningful and descriptive names for variables and functions.
  • Keep functions and methods small and focused on a single task.
  • Use comments to explain the purpose of complex code.
  • Follow the existing coding style and conventions used in the project.

Commit Message Template

Available Headers: ADD, FIX, REFACTOR, DELETE, DOCS.

Example Commit: ADD(Email): Implemented email sending

Commit Description: Brief optional summary of the change.

How to Make a Commit

  1. Commit Header:
    Choose one of the following options based on the type of change made:

    • ADD: For adding new features or files.
    • FIX: For fixing errors or bugs.
    • REFACTOR: For modifying code without changing its functionality.
    • DELETE: For removing code, files, or other entities.
    • DOCS: For changes related to documentation.

  2. Commit Content:
    Inside the parentheses (), specify what was modified in the commit.

  3. Commit Summary:
    After :, provide a brief and clear summary of the change made.

Detailed Example

ADD(Email): Implemented email sending functionality

- Implemented the `EmailSender` class to handle email sending using SMTP.
- Added necessary configurations in the `email_config.json` file.

Additional Notes

  • Keep commit messages clear and concise.
  • Use present tense in the summary (Implemented, Fixed, Refactored, Deleted, Documented) to indicate the action taken.
  • Ensure each commit represents a logical and coherent change in the code or documentation.

Thank You!

Your contributions make Shuemo better. Thank you for taking the time to contribute!