search

InKCre / .github

document of InKCreThing
Creative Commons Attribution Share Alike 4.0 International
0 stars 0 forks source link

Development workflow #8

Open xiaoland opened 6 months ago

xiaoland commented 6 months ago

Development doesn't equal coding, we develop to have a product.

Development is a process to make a requirement into implementation. A requirement could be feature or bug fixing, enhancement, etc. Mostly, implementation will be the code.

Then, it's a must to make sure our implementation is correct and suitable.

The result will be published in development-workflow.md under ``

xiaoland commented 5 months ago

Got An Idea

The idea can be enhancements or new features, but not a fix.

  1. start an issue or discussion (better with a form)
  2. provide sufficient evidence or reasons for developing it
  3. discuss a solution
  4. arrange the work
    • breakdown the solution into issues
    • track in feature project
    • configure priority, iteration, release ...
  5. create a new branch to do the issues (maybe more, depending on isolating conflict)
  6. create a pull request, wait for review, and test
  7. repeat 6-7 until all related issues closed
  8. close the initial issue
xiaoland commented 5 months ago

From the Product Requirement Document

Almost the same as the above, but be aware of these:

  1. breakdown the requirements using the User Story method
xiaoland commented 5 months ago

Bug Report

A behavior acts abnormally or finds vulnerabilities.

Almost the same as the above, but be careful with these:

  1. set labels to classify: bugs, security
  2. track them in Bug Tracker
xiaoland commented 5 months ago

懒得写英文了...

执行开发任务

或者说写代码

关于gitworkflow这块就不用多说了

这里主要是说如何进行开发与开发完成之后的PR处理

这里是组织全局性的，只制定一个大体的框架要求，具体的细节在每个项目的文档或者readme，guide中实现

xiaoland commented 5 months ago
xiaoland commented 5 months ago

... Everything will be fine with development going... Just remember to use tools, and make devOps