Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (67 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

100 lines (67 loc) · 1.9 KB

< Back

Contributing to JDER FastAPI

Thanks for your interest in contributing!

This is a guideline for contributing to JDER FastAPI.

Before the Contribution

Please install the following dependencies:

Dependencies Description
Python 3.13.0 Programming language
just Command runner
ls-lint Linting tool for directories and files
typos-cli Spell checker

Commands

The following commands are available:

Installing

This command will install and sync the dependencies.

just i

Default Command

This command will do linting, formatting and testing.

just

Linting

This command will lint the code.

just lint

Formatting

This command will format the code.

just fmt

Testing

This command will run all tests.

just test

Cleaning

This command will clean the unnecessary files.

just clean

This command will clean the unnecessary files and virtual environments.

just clean-all

Committing

When committing changes to the code, use the following prefixes:

  • chore: updates in dependencies/tools
  • build: changes to the build system
  • fix: fixes a bug
  • feat: adds a new feature
  • refactor: other code changes
  • perf: performance improvements
  • security: security related changes
  • style: style changes
  • test: adding or updating tests
  • docs: documentation only changes
  • ci: CI configuration updates
  • release: new version release

For example:

feat: add xxx feature
docs: fix typos