Docs: add issue-specification-document #59
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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** | ||
|
|
||
|
There was a problem hiding this comment. typo, should be committer |
||
| ##### **working for pr/mr** | ||
|
|
||
|
There was a problem hiding this comment. pr only, this is not gitlab we don't have 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. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the link didn't embed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe document is not compatible， i will check it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
already fix it