提交 b327cafb 编写于 作者: W wanderingbort 提交者: GitHub

Merge pull request #378 from ChristianDunst/patch-3

Fixed formatting of GITHUB_USAGE_PROCESS.md
......@@ -20,7 +20,7 @@ The purpose of this document is to explain the proper use of Github and task man
6. Check in your work daily
7. If you see improper usage, call it out! The team will be strongest when everyone is working the process together
<br/><br/>
###&nbsp;1. All commits must be associated with an existing issue.
### &nbsp;1. All commits must be associated with an existing issue.
Part of GitHub&#39;s functionality is an issue tracker called &quot;Issues,&quot; which can be used with every repository. It can be accessed via the repositories issues tab
......@@ -32,15 +32,15 @@ Every issue should contain:
2. In the body of the issue: A summary of the issue along with reproduction steps if suitable. Further information such as development environment, stack traces or error messages should be included for extra clarification, if possible.
3. A set of tags which correspond to the issue. This can be either a tag that groups the issue with related issues (such as the &quot;documentation&quot; tag) or expresses severity (&quot;PRIORITY&quot; tag).
<br/><br/>
###&nbsp;2. When working on an issue, add the &quot;In Progress&quot; tag
### &nbsp;2. When working on an issue, add the &quot;In Progress&quot; tag
In order to avoid collisions when two people work on the same issue, every developer needs to set the &quot;In Progress&quot; tag to the issue they plan to work on BEFORE the work actually starts. This step is furthermore of utmost importance, as it provides Dan with a way to track progress and reassign work in case issues of higher importance need to be fixed.
<br/><br/>
###&nbsp;3. Only have a max of one &quot;In Progress&quot; tag on an issue at any time
### &nbsp;3. Only have a max of one &quot;In Progress&quot; tag on an issue at any time
It is important, that every developer needs to have only one &quot;In Progress&quot; tag set at any time. This is to avoid accumulating a number of issues that are all half finished and therefore hindering other developers from picking them up, which in effect blocks the issue from being fixed.
<br/><br/>
###&nbsp;4. When not actively working on an issue, remove the &quot;In Progress&quot; tag
### &nbsp;4. When not actively working on an issue, remove the &quot;In Progress&quot; tag
As mentioned in the above paragraph, in order to avoid blocking an issue to be fixed by other developers, the &quot;In Progress&quot; tag needs to be removed as soon as the developer moves onto a different issue.
......@@ -48,7 +48,7 @@ However it is necessary to add an explanation to the issue itself which explains
Note: In case there was a block that made it impossible to fix the issue in the first time, a reference to the blocking issue has to be included in the explanation so it can be revisited once the blocking issue has been resolved and closed. Additionally there is a &quot;blocked&quot; tag which needs to be set.
<br/><br/>
###&nbsp;5. When opening pull requests, reference the issue in the description of the pull request
### &nbsp;5. When opening pull requests, reference the issue in the description of the pull request
After fixing an issue, open a pull request, with a proper explanation.
......@@ -58,12 +58,12 @@ The explanation includes:
2. A description of the fix: How has the issue been fixed? What is the expected outcome after closing of the issue?
3. In case the the fix has changed any functionality that either requires additional documentation to be added or existing documentation to be changed, it is HIGHLY recommended that the documentation work is part of the pull request. In case this is not done, the description needs to include keynotes on what documentation is either missing or which documentation needs to be changed.
<br/><br/>
###&nbsp;6. Check in your work daily
### &nbsp;6. Check in your work daily
At the end of the work day, submit your changes. In case an issue has been completely fixed, follow the above described process. When not finished with a task, submit the changes to your feature branch and explain the progress in the submission.
Note: This step is very important, since it enables Dan to track progress, plan future development and coordinate further task assignments.
<br/><br/>
###&nbsp;7. If you see improper usage, call it out! The team will be strongest when everyone is working the process together
### &nbsp;7. If you see improper usage, call it out! The team will be strongest when everyone is working the process together
Following the rules set above, are about streamlining the development process. They are essential in fulfilling the goals mention at the top of this document. This is even more important since the team is working in a distributed fashion with limited communication between the different team members.
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册