From 05c9294a3ed7fcefd6c4df5c2fe2359393da7a97 Mon Sep 17 00:00:00 2001 From: SgitBusity <72297937+AllianceTing@users.noreply.github.com> Date: Thu, 6 Jul 2023 14:54:43 +0800 Subject: [PATCH] Docs: modify issue-specification.md (#66) Co-authored-by: Xinwei Xiong <86140903+cubxxw@users.noreply.github.com> --- docs/contribution/issue specification.md | 40 ++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/contribution/issue specification.md diff --git a/docs/contribution/issue specification.md b/docs/contribution/issue specification.md new file mode 100644 index 0000000..5cd618a --- /dev/null +++ b/docs/contribution/issue specification.md @@ -0,0 +1,40 @@ +# 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://github.com/OpenIMSDK/OpenKF/issues/new/choose) 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 committer** + +##### **working for pr** + +- 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 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 make 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. +