Ensure that guides have consistent formatting #618
Conversation
Fixes #617. This change ensures that all the guides have consistent Markdown formatting. It does not make any changes to the content. Formatting changes include: - Use GitHub style markdown - Make heading levels consistent and incremental - Make external links extracted instead of inline Additionally, I came across and fixed some editorial issues while reviewing all the guides: - Fixed/removed broken links - Fixed capitalization of technologies - Fixed spelling errors - Improved the link text for some external links - Replaced references to "Slack" with "Basecamp"
WilHall
requested review from
mike-burns,
jferris,
edwardloveall,
ericwbailey and
enatario
|
Thanks for putting this together - consistent formatting certainly makes sense for a document about consistent formatting. It looks like some of the lines were reformatted to use different line lengths. We've traditionally stuck to 80 character limits for lines, and changing the length here makes it harder to tell what actually changed in some places. |
code-review/README.md
Outdated
| * Merge once you feel confident in the code and its impact on the project. | ||
| * Final editorial control rests with the pull request author. | ||
| - Be grateful for the reviewer's suggestions. ("Good call. I'll make that change.") | ||
| - A common axiom is "Don't take it personally. The review is of the code, not you." We used to include this, but now |
There was a problem hiding this comment.
Potentially out of scope, but I don't like this point. Maybe thread in a link to Edward's blog post to communicate that the reviewer also has a responsibility to communicate well?
There was a problem hiding this comment.
I greatly simplified this and linked to that article instead of the external resource. Thoughts?
|
|
||
| [Prey]: https://www.preyproject.com/ | ||
| [prey]: https://www.preyproject.com/ |
There was a problem hiding this comment.
I do but I don't like it
I've updated this, along with my autoformatter 🙂 |
* main: Expand the stack to include client-side frameworks Add HTML validation best practice (#588) Wrap in code to be consistent with line above’s factories.rb (#625) Remove the deprecated jscs configuration (#622) Restore Rubocop & Hound configuration (#623) Prefer MVVM on Android Update our Android best practices Added def tags to Data Glossary (#620) Fix typo in function components URL (#624) Fix broken link Ensure that guides have consistent formatting (#618) Combine style, best practice, and protocol guides (#615) Remove private/protected style guideline Rename Testing guide to Testing with RSpec (#614) Add back .rubocop.yml # Conflicts: # README.md
Fixes #617.
This change ensures that all the guides have consistent Markdown
formatting. It does not make any changes to the content.
Formatting changes include:
Additionally, I came across and fixed some editorial issues while
reviewing all the guides: