Skip to content
This repository was archived by the owner on Oct 11, 2022. It is now read-only.

Commit 2b8afd9

Browse files
authored
Merge pull request #4793 from withspectrum/add-todos-to-readme
Add project board to readme
2 parents dc2287f + 885f898 commit 2b8afd9

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ It is difficult to grow, manage and measure the impact of online communities. Co
2222
2323
### Status
2424

25-
Spectrum has been in full-time development since March 2017 and is [part of GitHub since November 2018](https://spectrum.chat/spectrum/general/spectrum-is-joining-github~1d3eb8ee-4c99-46c0-8daf-ca35a96be6ce).
25+
Spectrum has been in full-time development since March 2017 and is [part of GitHub since November 2018](https://spectrum.chat/spectrum/general/spectrum-is-joining-github~1d3eb8ee-4c99-46c0-8daf-ca35a96be6ce). See our current priorities and what we are working on in the [main project board](https://github.com/withspectrum/spectrum/projects/23).
2626

2727
<div align="center">
2828
<img height="50px" src="public/img/cluster-1.svg" />
@@ -51,7 +51,7 @@ Spectrum has been in full-time development since March 2017 and is [part of GitH
5151

5252
## Contributing
5353

54-
**We heartily welcome any and all contributions that match [our product roadmap](https://github.com/withspectrum/spectrum/projects/19) and engineering standards!**
54+
**We heartily welcome any and all contributions that match our engineering standards!**
5555

5656
That being said, this codebase isn't your typical open source project because it's not a library or package with a limited scope—it's our entire product.
5757

@@ -67,7 +67,9 @@ If you found a technical bug on Spectrum or have ideas for features we should im
6767

6868
#### Fixing a bug or implementing a new feature
6969

70-
If you find a bug on Spectrum and open a PR that fixes it we'll review it as soon as possible to ensure it matches our engineering standards. If you want to implement a new feature, open an issue first to discuss what it'd look like and to ensure it fits in [our roadmap](https://github.com/withspectrum/spectrum/projects/19) and plans for the app.
70+
If you find a bug on Spectrum and open a PR that fixes it we'll review it as soon as possible to ensure it matches our engineering standards.
71+
72+
If you want to implement a new feature, open an issue first to discuss what it'd look like and to ensure it fits in our roadmap and plans for the app (see [the main project board](https://github.com/withspectrum/spectrum/projects/23) for planned and currently ongoing work).
7173

7274
If you want to contribute but are unsure to start, we have [a "good first issue" label](https://github.com/withspectrum/spectrum/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) which is applied to newcomer-friendly issues. Take a look at [the full list of good first issues](https://github.com/withspectrum/spectrum/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and pick something you like! There is also [an "open" channel in the Spectrum community on Spectrum](https://spectrum.chat/spectrum/open) (how meta), if you run into troubles while trying to contribute that is the best place to talk to us.
7375

@@ -162,12 +164,11 @@ Spectrum has four big installation steps:
162164
1. **Install RethinkDB**: See [the RethinkDB documentation](https://rethinkdb.com/docs/install/) for instructions on installing it with your OS.
163165
2. **Install Redis**: See [the Redis documentation](https://redis.io/download) for instructions on installing it with your OS.
164166
3. **Install yarn**: We use [yarn](https://yarnpkg.com) to handle our JavaScript dependencies. (plain `npm` doesn't work due to our monorepo setup) See [the yarn documentation](https://yarnpkg.com/en/docs/install) for instructions on installing it.
167+
4. **Install the dependencies**: Because it's pretty tedious to install the dependencies for each worker individually we've created a script that goes through and runs `yarn install` for every worker for you: (this takes a couple minutes, so dive into the [technical docs](./docs) in the meantime)
165168

166-
Once you have RethinkDB, Redis and yarn installed locally its time to install the JavaScript dependencies. Because it's pretty tedious to install the dependencies for each worker individually we've created a script that goes through and runs `yarn install` for every worker for you: (this takes a couple minutes, so dive into the [technical docs](./docs) in the meantime)
167-
168-
```sh
169-
node shared/install-dependencies.js
170-
```
169+
```sh
170+
node shared/install-dependencies.js
171+
```
171172

172173
You've now finished installing everything! Let's migrate the database and you'll be ready to go :100:
173174

0 commit comments

Comments
 (0)