From 694f670bdde4029f8c4b6afc307c8c885d95145a Mon Sep 17 00:00:00 2001 From: AllianceTing <2426446427@qq.com> Date: Wed, 5 Jul 2023 18:37:26 +0800 Subject: [PATCH] feat: modify issue-specification.md Signed-off-by: AllianceTing <2426446427@qq.com> --- docs/ISSUE_SPECIFICATION.md | 38 +++++++++++++++++++++++++++++++++++++ issue specification.md | 22 --------------------- 2 files changed, 38 insertions(+), 22 deletions(-) create mode 100644 docs/ISSUE_SPECIFICATION.md delete mode 100644 issue specification.md diff --git a/docs/ISSUE_SPECIFICATION.md b/docs/ISSUE_SPECIFICATION.md new file mode 100644 index 0000000..209f7b9 --- /dev/null +++ b/docs/ISSUE_SPECIFICATION.md @@ -0,0 +1,38 @@ +# issue specification + +- we use [lot issues] (https://github.com/openIMSDK/openKF/issues) before reporting bugs, Please make sure that has been + searching similar [question] (https://github.com/OpenIMSDK/OpenKF/issues), because they may have already answered or + is being repaired. New questions should be directed to [Question Assistant](https://openIMSDK/issue-helper? + repo=openKF) submitted. For bug reports, include code that can be used to reproduce the problem and how to reproduce + it. For new feature suggestions, indicate the changes you want and the expected behavior. + +## **for commiter** + +##### **working for pr/mr** + +- commiters should finish code unit test again and record test dirary and if nessary do somke test +- commiters should check for code + convenant [code convenant](https://github.com/OpenIMSDK/OpenKF/CONTRIBUTING.md) + +##### **working for issue management** + +- add labels to each issue and check it out. +- format issue style when needed. +- keep in touch with each contributor. +- Keep up with the status of the issue. +- assign assign one or more who to solve it. + +## **for contributor** + +##### **raise issue** + +- developers should add full labels for issue you raised.(including **kind**(问题类型 such as,feat,bug),**Degree of + importance**(重要程度 emergency,important,normal),**strategy**(处置策略 such as self ,paticipant,coperation),* + *progress**(进度 such as running,later),**size**(问题规模 such as L,M,XXL)) + +##### **claim issue and meke pr** + +- developers can claim it by comment (want to claim + issueId) +- when doing pr process, developer should make Incremental testing at first and then doing **/contributor.md 's** + process. + diff --git a/issue specification.md b/issue specification.md deleted file mode 100644 index 4996c42..0000000 --- a/issue specification.md +++ /dev/null @@ -1,22 +0,0 @@ -# issue specification - -- 我们使用 [Github issues](https://github.com/openIMSDK/openKF/issues)报告 bug 之前,请确保已经搜索过类似的 [问题](https://github.com/OpenIMSDK/OpenKF/issues),因为它们可能已经得到解答或正在被修复。新问题应通过 [问题助手](https://openIMSDK/issue-helper?repo=openKF) 提交。对于 bug 报告,请包含可用于重现问题的代码和复现方式。对于新 feature 建议,请指出你想要的更改以及期望的行为。 - -## **for commiter** -##### **working for pr/mr** -- commiters should finish code unit test again and record test dirary and if nessary do somke test -- commiters should check for code convenant [code convenant](https://github.com/OpenIMSDK/OpenKF/blob/main/CONTRIBUTING.md) -##### **working for issue management** -- add labels to each issue and check it out. -- format issue style when needed. -- keep in touch with each contributor. -- Keep up with the status of the issue. -- assign assign one or more who to solve it. -## **for contributor** -##### **raise issue** -- developers should add full labels for issue you raised.(including **kind**(问题类型 such as,feat,bug),**Degree of importance**(重要程度 emergency,important,normal),**strategy**(处置策略 such as self ,paticipant,coperation),**progress**(进度 such as running,later),**size**(问题规模 such as L,M,XXL)) -##### **claim issue and meke pr** - -- developers can claim it by comment (want to claim + issueId) -- when doing pr process, developer should make Incremental testing at first and then doing **/contributor.md 's** process. -