docs: Update contributing and issue template (#2289)
This PR updates contributing and issue template to make easier
collaboration.
Fixes: #2288
Signed-off-by: Xuewei Niu <justxuewei@apache.org>
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
index 81e13ae..68d824e 100644
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -5,15 +5,30 @@
---
-<!-- Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks!
+### Environment
+<!--
+- Server: Dubbo-go, v3.0.5
+- Client: Dubbo-go, v3.0.5
+- Protocol: Triple
+- Registry: Nacos, v2.0.0
-->
+- Server:
+- Client:
+- Protocol:
+- Registry:
-**What happened**:
+### Issue description
-**What you expected to happen**:
+<!-- Here is a brief description about the issue. -->
-**How to reproduce it (as minimally and precisely as possible)**:
+### Logs
-**Anything else we need to know?**:
+<details><summary>Click me to check logs</summary>
+
+```
+Copy logs to here.
+```
+
+</details>
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
deleted file mode 100644
index 993b0a9..0000000
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ /dev/null
@@ -1,17 +0,0 @@
-<!-- Thanks for sending a pull request!
-Read https://github.com/apache/dubbo-go/blob/master/CONTRIBUTING.md before commit pull request.
--->
-
-**What this PR does**:
-
-**Which issue(s) this PR fixes**:
-Fixes #
-
-**You should pay attention to items below to ensure your pr passes our ci test**
-We do not merge pr with ci tests failed
-
-- [ ] All ut passed (run 'go test ./...' in project root)
-- [ ] After go-fmt ed , run 'go fmt project' using goland.
-- [ ] Golangci-lint passed, run 'sudo golangci-lint run' in project root.
-- [ ] Your new-created file needs to have [apache license](https://raw.githubusercontent.com/dubbogo/resources/master/tools/license/license.txt) at the top, like other existed file does.
-- [ ] All integration test passed. You can run integration test locally (with docker env). Clone our [dubbo-go-samples](https://github.com/apache/dubbo-go-samples) project and replace the go.mod to your dubbo-go, and run 'sudo sh start_integration_test.sh' at root of samples project root. (M1 Slice is not Support)
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 70ba0a4..937d1d6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,78 +1,53 @@
-Contributing to Dubbogo
+# Contributing
-## 1. Branch
+## Branch
- >- The name of branches `SHOULD` be in the format of `feature/xxx`.
- >- You `SHOULD` checkout a new branch after a feature branch already being merged into upstream, `DO NOT` commit in the old branch.
+Our default branch is `main`, which receives new features and bugfixes. Release
+branches, e.g. `release-3.0`, will not received new features but bugfixes.
+Opening a pull request for the release branches is what we called "backport".
-## 2. Pull Request
+## Title
-### 2.1. Title Format
+The format of the title of PRs should be:
-The pr head format is `<head> <subject>`. The title should be simpler to show your intent.
-
-The title format of the pull request `MUST` follow the following rules:
-
- >- Start with `Doc:` for adding/formatting/improving docs.
- >- Start with `Mod:` for formatting codes or adding comment.
- >- Start with `Fix:` for fixing bug, and its ending should be ` #issue-id` if being relevant to some issue.
- >- Start with `Imp:` for improving performance.
- >- Start with `Ftr:` for adding a new feature.
- >- Start with `Add:` for adding struct function/member.
- >- Start with `Rft:` for refactoring codes.
- >- Start with `Tst:` for adding tests.
- >- Start with `Dep:` for adding depending libs.
- >- Start with `Rem:` for removing feature/struct/function/member/files.
-
-## 3. Code Style
-
-Please add a blank line at the end of every file.
-
-Please add a blank line at the sub-title and its content.
-
-Please add s space between the Engilsh word/digit number and the Chinese character.
-
-### 3.1 log
-
->- 1 when logging the function's input parameter, you should add '@' before input parameter name.
-
-### 3.2 naming
-
->- 1 do not use an underscore in package name, such as `filter_impl`.
->- 2 do not use an underscore in constants, such as `DUBBO_PROTOCOL`. use 'DubboProtocol' instead.
-
-### 3.3 comment
-
->- 1 there should be comment for every export func/var.
->- 2 the comment should begin with function name/var name.
-
-### 3.4 import
-
-We dubbogo import blocks should be splited into 3 blocks.
-
-```Go
-// block 1: the go internal package
-import (
- "fmt"
-)
-
-// block 2: the third package
-import (
- "github.com/dubbogo/xxx"
-
- "github.com/RoaringBitmap/roaring"
-)
-
-// block 3: the dubbo-go package
-import (
- "dubbo.apache.org/dubbo-go/v3/common"
-)
+```
+<type>: One line summary of the PR
```
-### 3.5 package
+The types are including(https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/):
-There should be a blank line between the license and the package name.
+- feat: a new feature is introduced with the changes
+- fix: a bug fix has occurred
+- chore: changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies)
+- refactor: refactored code that neither fixes a bug nor adds a feature
+- docs: updates to documentation such as a the README or other markdown files
+- style: changes that do not affect the meaning of the code, likely related to code formatting such as white-space, missing semi-- - colons, and so on.
+- test: including new or correcting previous tests
+- perf: performance improvements
+- ci: continuous integration related
+- build: changes that affect the build system or external dependencies
+- revert: reverts a previous commit
-The package name should not have "xxx_impl".
+If this PR is to backport to other branchs, e.g. `3.0`, then the title would be:
+```
+[3.0] <type>: One line summary of the PR
+```
+## Commit message
+
+Each pull request **MUST** have a corresponding issue to explain what does this PR do. The format of message should be:
+
+```
+(A brief description about this PR.) Lorem ipsum dolor sit amet, consectetur
+adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna
+aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi
+ut aliquip ex ea commodo consequat.
+
+Fixes: #1000
+
+Signed-off-by: Example <example@example.com>
+```
+
+The signed-off message will be appended automaticaly if the developers commit
+with `-s` option, for example, `git commit -s`.
\ No newline at end of file
