Skip to content

Commit

Permalink
Update contributing document
Browse files Browse the repository at this point in the history
  • Loading branch information
rexzhang committed Jun 14, 2024
1 parent 77d27db commit 17ad0e4
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions docs/contributing.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,33 @@

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 -> fork -> PR Draft -> CI -> merge
- issue
- discuss of the technical solution
- PR Draft
- discuss of technical details
- review code
- check document
- check/update document

## Code

Expand Down

0 comments on commit 17ad0e4

Please sign in to comment.