fix-the-web
fix-the-web copied to clipboard
Let's fix it together.. One line at a time!
Fix The Web
Let's fix it together.. One line at a time!
What is this?
If you are persnickety like I am, you can easily fix quite a few things and at the same time contribute to your favorite project. It's never too late to start contributing instead of just consuming.
Contents
- EditorConfig
-
Search and Replace
-
Github
=>GitHub
-
Javascript
=>JavaScript
-
OSX
,OS X
,MacOS
=>macOS
-
XCode
=>Xcode
-
EditorConfig
No matter how many people contribute to the code, it should always look like it was written by one person.
And with that in mind it's a good idea to add the EditorConfig into your favorite project.
Create a new file in the root called .editorconfig
by respecting the coding styles that already applied. Here is an example:
# editorconfig.org
root = true
[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
Get ideas from: React, Visual Studio Code, Angular JS and gae-init.
Search and Replace
Recommended renames
We recommend to submit each of the following possible fixes in a separate Pull Request.
Search for | Replace with |
---|---|
Github |
GitHub |
Javascript |
JavaScript |
OSX , OS X , MacOS |
macOS |
XCode |
Xcode |
Yes, but how?
- Find your favorite project and Fork it
- Clone it and open the project in your favorite editor
- Search all for exact match of
Github
and replace it withGitHub
- Create a new branch:
git checkout -b fix-case
- Commit all changes:
git commit -am 'Fix case: Github to GitHub'
- Push your changes:
git push origin fix-case
- Create pull request to the original project
- Be polite!