Skip to content

Commit 63e08aa

Browse files
committed
update docs
1 parent 535e505 commit 63e08aa

File tree

2 files changed

+32
-9
lines changed

2 files changed

+32
-9
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
### Changelog
22

3-
#### 0.8.3 (Next)
3+
#### 0.8.4 (Next)
44

55
* Your contribution here.
66

7+
#### 0.8.3 (2018/11/17)
8+
9+
* [#83](https://github.com/slack-ruby/slack-ruby-bot-server/pull/83): Prevents name collision for Teams, allow configuration of ActiveRecord table name. - [@leechou](https://github.com/leechou).
10+
711
#### 0.8.2 (2018/10/11)
812

913
* [#80](https://github.com/slack-ruby/slack-ruby-bot-server/pull/80): Fix: closed stream when closing connection in ping worker - [@dblock](https://github.com/dblock).

CONTRIBUTING.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In the examples below, substitute your Github username for `contributor` in URLs
1010

1111
Fork the [project on Github](https://github.com/slack-ruby/slack-ruby-bot-server) and check out your copy.
1212

13-
```
13+
```bash
1414
git clone https://github.com/contributor/slack-ruby-bot-server.git
1515
cd slack-ruby-bot-server
1616
git remote add upstream https://github.com/slack-ruby/slack-ruby-bot-server.git
@@ -20,7 +20,7 @@ git remote add upstream https://github.com/slack-ruby/slack-ruby-bot-server.git
2020

2121
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
2222

23-
```
23+
```bash
2424
git checkout master
2525
git pull upstream master
2626
git checkout -b my-feature-branch
@@ -30,11 +30,30 @@ git checkout -b my-feature-branch
3030

3131
Ensure that you can build the project and run tests.
3232

33-
```
33+
```bash
34+
export DATABASE_ADAPTER='activerecord'
3435
bundle install
3536
bundle exec rake
3637
```
3738

39+
## Run Tests
40+
41+
Run tests before making changes and then run tests after major commits.
42+
Make sure to test both ActiveRecord and Mongoid.
43+
44+
```bash
45+
export DATABASE_ADAPTER='activerecord'
46+
bundle install
47+
bundle exec rspec
48+
```
49+
50+
Test the sample apps
51+
52+
```bash
53+
cd sample_apps/sample_app_active_record
54+
ln -s ../../lib .
55+
```
56+
3857
## Write Tests
3958

4059
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
@@ -64,21 +83,21 @@ Make it look like every other line, including your name and link to your Github
6483

6584
Make sure git knows your name and email address:
6685

67-
```
86+
```bash
6887
git config --global user.name "Your Name"
6988
git config --global user.email "contributor@example.com"
7089
```
7190

7291
Writing good commit logs is important. A commit log should describe what changed and why.
7392

74-
```
93+
```bash
7594
git add ...
7695
git commit
7796
```
7897

7998
## Push
8099

81-
```
100+
```bash
82101
git push origin my-feature-branch
83102
```
84103

@@ -91,7 +110,7 @@ Click the 'Pull Request' button and fill out the form. Pull requests are usually
91110

92111
If you've been working on a change for a while, rebase with upstream/master.
93112

94-
```
113+
```bash
95114
git fetch upstream
96115
git rebase upstream/master
97116
git push origin my-feature-branch -f
@@ -107,7 +126,7 @@ Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical ent
107126

108127
Amend your previous commit and force push the changes.
109128

110-
```
129+
```bash
111130
git commit --amend
112131
git push origin my-feature-branch -f
113132
```

0 commit comments

Comments
 (0)