Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (29 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.65 KB

Contributing to InternUtopia

Thank you for your interest in contributing to InternUtopia! We welcome contributions from everyone. Please take a moment to review this guide to ensure a smooth collaboration.

Submitting Code Changes

  • We use the pre-commit configuration to automatically clean up code before committing. Install and run pre-commit as follows:

    1. Install pre-commit:
    pip install pre-commit
    1. Install hooks from the configuration file at the root of the repository:
    pre-commit install

    After this, pre-commit will automatically check and clean up code whenever you make a commit.

    1. Before opening a pull request, run the following command to check all files are cleaned up:
    pre-commit run --all-files

  • In the title of your Pull Request, please include [BUG FIX], [FEATURE] or [MISC] to indicate the purpose.

  • In the description, please provide example code or commands for testing.

  • For commit messages, please follow the Conventional Commits specification.

Reviewing and Merging

  • PRs require at least one approval before merging.
  • Automated checks (e.g., CI tests) must pass.
  • Use Squash and Merge for a clean commit history.