Skip to content

Commit fd3a77a

Browse files
committed
Update CONTRIBUTING.md.
1 parent 8e15fa0 commit fd3a77a

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,40 @@
44

55
Deployed to https://rfcbot.rs right now.
66

7+
## Code of Conduct
8+
9+
All contributors are expected to follow our [Code of Conduct][conduct].
10+
711
## Development
812

913
### Chat
1014

11-
There is an `#rfcbot` channel in the `ops` section of the [rust-lang discord server](https://discordapp.com/invite/rust-lang).
15+
There is an `#rfcbot` channel in the `ops` section of the
16+
[rust-lang discord server](https://discordapp.com/invite/rust-lang).
1217

1318
### Rust Version
1419

15-
Rust nightly is required, as rfcbot uses [Rocket](rocket.rs). If you use rustup, this version is managed for you by a `rust-toolchain` file at the repository root.
20+
Rust nightly is required, as rfcbot uses [Rocket](rocket.rs). If you use rustup, this version is
21+
managed for you by a `rust-toolchain` file at the repository root.
1622

1723
### Running locally
1824

19-
Install [Docker](https://docker.dom) and [docker-compose](https://docs.docker.com/compose) and ensure they're working.
25+
Install [Docker](https://docker.dom) and [docker-compose](https://docs.docker.com/compose) and
26+
ensure they're working.
2027

21-
Next, start development services and initialize the database:
22-
23-
```
24-
cargo install diesel_cli
25-
docker-compose up -d
26-
./setup-db.sh
27-
```
28+
Next, start development services and initialize the database with `docker-compose up`.
2829

29-
After this you may need to run `docker-compose down`/`docker-compose up -d` for the server process to see the database updates.
30+
Press `Ctrl+C` to exit the server process. The container build is not (yet?) aware of how to detect
31+
changes to source files, so once you have made changes you will need to run `docker-compose build`
32+
before running `docker-compose up` to see your changes take effect.
3033

31-
By default this stores your database files in `target/data/`, so any temporary changes you make to the database will be removed by a `cargo clean` and you'll need to run the above commands again.
34+
By default this stores your database files in `target/data/`, so any temporary changes you make to
35+
the database will be removed by a `cargo clean` and you'll need to run the above commands again.
3236

3337
### Database dumps
3438

35-
It can be useful to have a database with some existing data to start from. "Bootstrap" files are available at https://www.dropbox.com/sh/dl4pxj1d49ici1f/AAAzZQxWVqQzVk_zOksn0Rbya?dl=0.
39+
It can be useful to have a database with some existing data to start from. "Bootstrap" files are
40+
available at https://www.dropbox.com/sh/dl4pxj1d49ici1f/AAAzZQxWVqQzVk_zOksn0Rbya?dl=0.
3641

3742
Assuming that you download the most recent file in the above folder and name it `bootstrap.sql`:
3843

@@ -43,12 +48,12 @@ psql -d $DATABASE_URL -f bootstrap.sql
4348

4449
## Deployment
4550

46-
Deployed to Heroku via TravisCI from the master branch. See (.travis.yml)[./travis.yml] for an up-to-date listing of the actions.
47-
48-
## Conduct
49-
50-
This project has a [Code of Conduct and moderation policy](https://github.com/rust-lang/rfcbot-rs/blob/master/CONDUCT.md) very similar to the Rust CoC.
51+
Deployed to Heroku via TravisCI from the master branch. See [.travis.yml](./travis.yml) for an
52+
up-to-date listing of the actions.
5153

5254
## License
5355

54-
This project is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE-MIT and LICENSE-APACHE for details.
56+
This project is distributed under the terms of both the MIT license and the Apache License
57+
(Version 2.0). See LICENSE-MIT and LICENSE-APACHE for details.
58+
59+
[conduct]: https://www.rust-lang.org/conduct.html

0 commit comments

Comments
 (0)