Skip to content

Commit 1cbf185

Browse files
committed
Update README
1 parent cb1eb0a commit 1cbf185

File tree

2 files changed

+16
-19
lines changed

2 files changed

+16
-19
lines changed

CONTRIBUTING.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,21 @@ great tool.
1616
**executable test case** demonstrating the expected behavior that is
1717
not occurring.
1818

19+
### **Development collaboration**
1920

20-
#### **Did you write a patch that fixes a bug?**
21+
We have good quality assurance and an established workflow. This is it:
2122

22-
* Open a new GitHub pull request with the patch.
23+
1. Open a new GitHub pull request
24+
- In the form of a User Story (As `<persona>`, [When I `<state>` ],
25+
I want `<something>`, so that `<measurable achievement>`
26+
1. New Branch in Git
27+
- Naming: (feature|bugfix|chore)/short-description
28+
1. Develop / Test Locally until tests pass on CI
29+
1. Create Merge Request on Gitlab to Integration.
30+
1. Core Team: Merge to Integration, deploy and accept the Issue on Github
2331

24-
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
32+
* Ensure the PR description clearly describes the problem and
33+
solution. Include the relevant issue number if applicable.
2534

2635
Thanks! :heart: :heart: :heart:
2736

README.org

+4-16
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ start their own crowdfunding platform or campaign.
3131

3232
macOS: =brew install rbenv=
3333

34+
Official rbenv documentation: https://github.com/rbenv/rbenv.
35+
3436
**** Install Ruby version 2.4.1
3537

3638
macOS: =rbenv install 2.4.1=
@@ -55,7 +57,7 @@ however that you can easily use by:
5557

5658
=cd config; ln -s database.yml.example database.yml; cd -=
5759

58-
Alternatively you can configure PG, MySQL or others.
60+
Alternatively you can configure PostgreSQL, MySQL or others.
5961

6062
**** Migrate Database
6163

@@ -74,7 +76,7 @@ Automatically run tests while development
7476
guard
7577
#+END_SRC
7678

77-
For Emacs Users: When using `enh-ruby-mode`, this will also
79+
Note for Emacs Users: When using =enh-ruby-mode=, this will also
7880
automatically color your status bar either green on success or red on error.
7981

8082
**** Live Reload
@@ -84,20 +86,6 @@ and saving of =*.erb= files will reload your browser. Developing
8486
=*.scss= files will also hot-load the respective CSS within the
8587
browser.
8688

87-
**** Development collaboration
88-
89-
We have good quality assurance and an established workflow. This is it:
90-
91-
1. New Story in this README, section TODOs
92-
- In the form of a User Story (As =<persona>=, [When I =<state>= ],
93-
I want =<something>=, so that =<measurable achievement>=
94-
1. New Branch in Git
95-
- Naming: (feature|bugfix|chore)/short-description
96-
1. Develop / Test Locally until tests pass on CI
97-
1. Create Merge Request on Gitlab to Master. Assign someone to review.
98-
1. Finish Story
99-
1. Assigned person: Merge to Master, deploy and accept the story on Pivotal
100-
10189
*** Deployment
10290

10391
**** Premise

0 commit comments

Comments
 (0)