Documentation: Update README and CONTRIBUTING #1199
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stevepolitodesign
force-pushed
the
suspenders-3-0-0-update-documentation
branch
4 times, most recently
from
6714748
to
e2eef35
Compare
stevepolitodesign
changed the title
Simplify `README` in an effort to highlight what really matters, and remove references to each generator. Instead, we introduce `FEATURES.md` which was modified from the `README` generated by `bin/rails suspenders:cleanup:generate_readme` Updates `CONTRIBUTING` guide to account for changes in the test suite. Since this new build was generated from am [engine][], we no longer use RSpec, and instead use the default test suite. Remove reference to styleguide since the link is broken, and update link to Suspenders boy to use HTTPS. [engine]: https://guides.rubyonrails.org/engines.html
stevepolitodesign
force-pushed
the
suspenders-3-0-0-update-documentation
branch
from
e2eef35
to
627ac49
Compare
stevepolitodesign
added a commit
that referenced
this pull request
May 10, 2024
Simplify `README` in an effort to highlight what really matters, and remove references to each generator. Instead, we introduce `FEATURES.md` which was modified from the `README` generated by `bin/rails suspenders:cleanup:generate_readme` Updates `CONTRIBUTING` guide to account for changes in the test suite. Since this new build was generated from am [engine][], we no longer use RSpec, and instead use the default test suite. Remove reference to styleguide since the link is broken, and update link to Suspenders boy to use HTTPS. [engine]: https://guides.rubyonrails.org/engines.html
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Simplify
READMEin an effort to highlight what really matters, andremove references to each generator.
Instead, we introduce
FEATURES.mdwhich was modified from theREADMEgenerated by
bin/rails suspenders:cleanup:generate_readmeUpdates
CONTRIBUTINGguide to account for changes in the test suite.Since this new build was generated from am engine, we no longer use
RSpec, and instead use the default test suite.
Remove reference to styleguide since the link is broken, and update link
to Suspenders boy to use HTTPS.