Skip to content

Commit d98d532

Browse files
committed
declare the Prerequisite(s) for understanding this project at top of readme! #1
1 parent 2063681 commit d98d532

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

+17-16
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ the **people** need to **perform** <br />
1111
to get their work `done` and **help everyone communicate better**
1212
with team members_. <br />
1313

14-
## _Prerequisite to Understanding this Project_
14+
## _Prerequisite to Understanding `dwylbot`_
1515

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:
1818

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)
2121

2222
Please read them and come back!
2323

@@ -30,8 +30,8 @@ designed to ensure everyone in the team
3030
can communicate and see the status of work.<br />
3131

3232
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 />
3535

3636
> "_You missed a step in the workflow which means
3737
the team is unaware of state/progress on this feature..._" <br />
@@ -44,10 +44,8 @@ once all the tests have passed on CI..._" <br />
4444
> For a **list** of these common scenarios see:
4545
https://github.com/dwyl/dwylbot/issues/5
4646

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***!
5149

5250

5351
## _What_?
@@ -61,9 +59,10 @@ We _also_ use GitHub to ***discuss*** questions/ideas/features/improvements,
6159
(_or "fix" an existing feature that is not working as expected_)
6260
and then to ***track*** the ***progress*** while the work is being done and
6361
***record*** how much ***time*** a person spent on the task/feature.
64-
6562
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***!
6766

6867
## _How_?
6968

@@ -84,12 +83,14 @@ to start understanding the project, but it helps to know the basics._
8483
### Run The Project _Locally_!
8584

8685
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.
8887

89-
> _**Note**: only try to run this on your computer once
88+
> _**Note**: **only** `try` to run this on your computer once
9089
you've understood Elixir & Phoenix._
9190

92-
#### Clone the Repository (_to your personal computer_)
91+
#### Clone the Repository
92+
93+
Clone the GitHub repo _to your personal computer_:
9394

9495
```
9596
git clone [email protected]:dwyl/dwylbot.git && cd dwylbot

0 commit comments

Comments
 (0)