I’ve been wondering if I could perform bulk cosmetic changes on Rails Guides for integrity. Currently the inconsistency disturbs us when updating Rails Guides translations.
Of course I recognize that a policy that is stated in #13771: staggered cosmetic changes would disturb other developers especially when git blame. So I thought I had no chance to do that.
Then we can add the cosmetic commits to .git-blame-ignore-revs to ignore them when git blame.
GitHub already supports the feature on Web UI, assuming the filename .git-blame-ignore-revs.
I guess this feature may be a good tool for us to perform bulk cosmetic changes on Rails Guides to make the style consistent.
Considerations:
Each developer has to perform the git config above to activate them?
Whether the filename .git-blame-ignore-revs is ready for other repositories or tools such as GitLab or Git Lens
The bulk cosmetic commits should be squashed to avoid slowing down.
ruby_on_rails_guides_guidelines.md should also be updated to describe this.
They provide many existing rules and it seems straight-forward to add our own custom rules, like for the ones you’re suggesting. There is already a rule for line-length, which I’ve set to 2000 but we can put it somewhere more reasonable, like 200. I’m not sure how you would detect fragmented paragraphs however, still some interesting stuff to work with that will hopefully save us and contributors time in code review.