Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

95 lines (68 loc) · 3.58 KB
Raw

Contributing

Get Started

Preparation

SportOrg runs on Python 3.8 for compatibility with Windows 7. Latest Python 3.8 release with binary installers is Python 3.8.10.

During development, the poetry and poe tools are used. The preferred method for installing these utilities is pipx.

It may be necessary to restart the terminal window during the installation process to update the PATH environment variable.

pip install pipx
pipx ensurepath
pipx install poetry
pipx install poethepoet

Create Virtual Environment

Get pysport project.

git clone https://github.com/sportorg/pysport.git
cd pysport

If multiple versions of Python are installed, it is necessary to specify the path to the Python 3.8 executable file.

poetry env use /full/path/to/python3.8

Install requirements.

poetry install
poetry install -E win  # for Windows

Add DEBUG=True to .env file or cp .env.example .env

Run SportOrg

poe run

Write a code

poe format
poe lint
poe test

Build

cx_Freeze

python builder.py build

Commit Message Format

This project adheres to Conventional Commits. A specification for adding human and machine readable meaning to commit messages.

Commit Message Header

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope
  │
  └─⫸ Commit Type: feat|fix|build|ci|docs|perf|refactor|test|chore

Type

type name description
feat Features A new feature
fix Bug Fixes A bug fix
docs Documentation Documentation only changes
style Styles Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor Code Refactoring A code change that neither fixes a bug nor adds a feature
perf Performance Improvements A code change that improves performance
test Tests Adding missing tests or correcting existing tests
build Builds Changes that affect the build system or external dependencies (example scopes: mypy, pip, pytest)
ci Continuous Integrations Changes to our CI configuration files and scripts (example scopes: Github Actions)
chore Chores Other changes that don't modify src or test files
revert Reverts Reverts a previous commit