Contributing

2022-02-262026-06-22

New feature, bug fix, new language, new howto, typo fix; everything is fine.

If you want to participate in this project, you are welcome to start by translating/writing documents.

Basic principles

Target user

• Self-hosting(as app, with docker container)
• Developers using ASGI frameworks

User strategy

Normal user

• Out-of-the-box
• Guiding users to improve their configuration through log messages

Power user

• Flexibility should be provided without affecting the normal user

Workflow

graph TD
    A[Proposal in Github Issue] -->|fork| C[PR Draft]
    C --> D[CI] --> C
    D -->|Out of Draft mode| E[review] --> C
    E --> F[merge]

Proposal

• Why/How/Who
• discuss of the technical solution

PR Draft

• create PR in Draft mode
• discuss of technical details
• add/check/update unit test
• check/update document
• CI/review code(move out Draft mode)

Coding

Prepare

git clone https://github.com/rexzhang/asgi-webdav.git
cd asgi-webdav
pip install -U -r requirements.txt

Run Dev Server

python -m asgi_webdav --dev

Check commit by pre-commit

pip install pre-commit
pre-commit install
pre-commit run -a

Check by mypy

pip install -U -r requirements.d/mypy.txt
mypy

Documentation

Create a new document file

nano docs/howto/this-is-a-new-howto.en.md

Preview

pip install -U -r requirements.d/mkdocs.txt
fab mkdocs