From 17ad0e4b8e03e5501385b34a0d257a764f2ada39 Mon Sep 17 00:00:00 2001 From: Rex Zhang Date: Fri, 14 Jun 2024 20:28:12 +0800 Subject: [PATCH] Update contributing document --- docs/contributing.en.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/contributing.en.md b/docs/contributing.en.md index b04a1c9..87bf34f 100644 --- a/docs/contributing.en.md +++ b/docs/contributing.en.md @@ -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