@@ -11,13 +11,13 @@ the **people** need to **perform** <br />
11
11
to get their work ` done ` and ** help everyone communicate better**
12
12
with team members_ . <br />
13
13
14
- ## _ Prerequisite to Understanding this Project _
14
+ ## _ Prerequisite to Understanding ` dwylbot ` _
15
15
16
- The purpose of this project will remain unclear
17
- if you have not read the following guides :
16
+ The purpose of ` dwylbot ` will remain _ unclear _
17
+ if you have not read the following:
18
18
19
- + https://github.com/dwyl/github-reference
20
- + https://github.com/dwyl/contributing
19
+ + [ github.com/dwyl/ ** github-reference ** ] ( https://github.com/dwyl/github-reference )
20
+ + [ github.com/dwyl/ ** contributing ** ] ( https://github.com/dwyl/contributing )
21
21
22
22
Please read them and come back!
23
23
@@ -30,8 +30,8 @@ designed to ensure everyone in the team
30
30
can communicate and see the status of work.<br />
31
31
32
32
Learning the Workflow is never _ instantaneous_ .
33
- We ( _ the people who already know the steps in our Workflow _ )
34
- _ often _ need to _ remind _ others who are new to it . e.g:<br />
33
+ At the start of a project the more _ experienced _ people in the team
34
+ end up having to do a bit of " _ workflow mentoring _ " . e.g: <br />
35
35
36
36
> "_ You missed a step in the workflow which means
37
37
the team is unaware of state/progress on this feature..._" <br />
@@ -44,10 +44,8 @@ once all the tests have passed on CI..._" <br />
44
44
> For a ** list** of these common scenarios see:
45
45
https://github.com/dwyl/dwylbot/issues/5
46
46
47
- At the start of a project the more _ experienced_ people in the team
48
- end up having to do a lot of "_ workflow mentoring_ " <br />
49
- ` dwylbot ` *** automates*** giving "*** workflow specific feedback*** "
50
- which *** saves everyone time*** ! Thanks ` dwylbot ` , we _ love you_ !!
47
+ ` dwylbot ` *** automates*** giving "*** workflow related feedback*** "
48
+ which *** saves everyone time*** !
51
49
52
50
53
51
## _ What_ ?
@@ -61,9 +59,10 @@ We _also_ use GitHub to ***discuss*** questions/ideas/features/improvements,
61
59
(_ or "fix" an existing feature that is not working as expected_ )
62
60
and then to *** track*** the *** progress*** while the work is being done and
63
61
*** record*** how much *** time*** a person spent on the task/feature.
64
-
65
62
We refer to this as our "Workflow".
66
- The "job" of ` dwylbot ` is to help the humans learn & follow the Workflow.
63
+
64
+ ` dwylbot ` helps the humans learn & follow the Workflow
65
+ so we *** communicate better*** and *** get more done*** !
67
66
68
67
## _ How_ ?
69
68
@@ -84,12 +83,14 @@ to start understanding the project, but it helps to know the basics._
84
83
### Run The Project _ Locally_ !
85
84
86
85
The "_ production_ " version of ` dwylbot ` runs on Heroku,
87
- but we _ develop_ it locally and you can easily run it on your computer.
86
+ but we _ develop_ it locally and you can _ easily _ run it on your computer.
88
87
89
- > _ ** Note** : only try to run this on your computer once
88
+ > _ ** Note** : ** only** ` try ` to run this on your computer once
90
89
you've understood Elixir & Phoenix._
91
90
92
- #### Clone the Repository (_ to your personal computer_ )
91
+ #### Clone the Repository
92
+
93
+ Clone the GitHub repo _ to your personal computer_ :
93
94
94
95
```
95
96
git clone [email protected] :dwyl/dwylbot.git && cd dwylbot
0 commit comments