* Improve format and clarity of the docs [ci skip] While this change produces a lot of git noise by enacting what seems like an arbitrary linewrap on most of the files in the documentation it will result in better version control and tracking of the changes in the documentation. For example, as it currently stands, if one was to make a PR to move a comma in a sentence because each paragraph in most of the files is on a single line, that small change would look in the git history like the author had modified the entire paragraph. In reality, this author just moved a comma. This change also includes a significant number of modifications to the more article-esque docs. Many of these docs were written in a sort of stream-of-conciousness and aren't as easy to read as they could be. Hopefully this is the first of several readability changes. If we could get these docs to a more accessible reading level, we would probably see an increase in contributions. :) * Delegate markdown wrapping to Prettier * Add linewrapping explanation in the docs [ci skip]
632 B
632 B
| title |
|---|
| Suggested Workflow |
Suggested workflow
We use Spring, and it is already included in the project.
- Use the provided bin stubs to automatically start Spring, i.e.
bin/rails server,bin/rspec spec/models/,bin/rails db:migrate. - If Spring isn't picking up on new changes, use
spring stop. For example, Spring should always be restarted if there's a change in the environment keys. - Check Spring's status whenever with
spring status.
Caveat: bin/rspec is not equipped with Spring because it affects Simplecov's
result. Instead, use bin/spring rspec.