Contributing

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)
• ASGI framework user

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

issue -> fork -> PR Draft -> CI -> merge

Issue

• discuss of the technical solution

PR Draft

• discuss of technical details
• review code
• check/update document

Code

Prepare

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

Run Dev Server

python -m asgi_webdav --dev

Documentation

Create a new language translation

Example

cp docs/index.en.md docs/index.zh.md

Update MkDocs's config file

mkdocs.txt example

- i18n:
    docs_structure: suffix
    languages:
      - locale: en
        default: true
        name: English
        build: true
      - locale: zh
        name: 中文
        build: true
        nav_translations:
          Home: 首页
          Getting started: 开始配置
          How To: 如何做
          Reference: 参考
          Trouble Shooting: 问题处理

Ref

• ISO 639-1 language code
• MkDocs's i18n plugin

Create a new howto

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

Preview

pip install -U -r requirements/mkdocs.txt
mkdocs serve