From 049c7d8a0977ccf01c4d15a30c16966b5be263bf Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 14 Jun 2024 10:20:59 +0800 Subject: [PATCH 1/2] Have new announcement about docs contributions --- .github/pull_request_template.md | 11 ++++++----- CONTRIBUTING.md | 3 ++- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b752abb794dec..b7594a1ba7fa1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,10 @@ - + Please check the following: 1. Make sure you are targeting the `main` branch, pull requests on release branches are only allowed for backports. 2. Make sure you have read contributing guidelines: https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md . -3. Describe what your pull request does and which issue you're targeting (if any). -4. It is recommended to enable "Allow edits by maintainers", so maintainers can help more easily. -5. Your input here will be included in the commit message when this PR has been merged. If you don't want some content to be included, please separate them with a line like `---`. -6. Delete all these tips before posting. +3. For documentations contribution, please go to https://gitea.com/gitea/docs +4. Describe what your pull request does and which issue you're targeting (if any). +5. It is recommended to enable "Allow edits by maintainers", so maintainers can help more easily. +6. Your input here will be included in the commit message when this PR has been merged. If you don't want some content to be included, please separate them with a line like `---`. +7. Delete all these tips before posting. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04c06ffd14efe..6db13d2660009 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -358,7 +358,8 @@ $REWRITTEN_PR_SUMMARY ## Documentation -If you add a new feature or change an existing aspect of Gitea, the documentation for that feature must be created or updated in the same PR. +If you add a new feature or change an existing aspect of Gitea, the documentation for that feature must be created or updated in another PR at [https://gitea.com/gitea/docs](https://gitea.com/gitea/docs). +**The docs directory on main repository will be removed at some time. We will have a yaml file to store configuration file's meta data. After that completed, configuration documentation should be in the main respository.** ## API v1 From 43fb0f5b0e469e12023c0fde78e5b8914814dbf9 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 14 Jun 2024 10:24:23 +0800 Subject: [PATCH 2/2] Fix spell --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6db13d2660009..60146276dba0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -359,7 +359,7 @@ $REWRITTEN_PR_SUMMARY ## Documentation If you add a new feature or change an existing aspect of Gitea, the documentation for that feature must be created or updated in another PR at [https://gitea.com/gitea/docs](https://gitea.com/gitea/docs). -**The docs directory on main repository will be removed at some time. We will have a yaml file to store configuration file's meta data. After that completed, configuration documentation should be in the main respository.** +**The docs directory on main repository will be removed at some time. We will have a yaml file to store configuration file's meta data. After that completed, configuration documentation should be in the main repository.** ## API v1