Skip to content

Conversation

@SethFalco
Copy link
Member

@SethFalco SethFalco commented Apr 3, 2023

What does it do?

  • Adds .editorconfig file.
  • Fix some typos in the README.
    • Homebrew is a noun, preserve capitalization.
    • "a an", only one of these is required, not both.

Why the change?

EditorConfig is an editor/vendor agnostic configuration file to make following project conventions easier. Afaik (at least looking at the largest C projects on GitHub) there aren't clear conventions on things like indentation.

Rather than having to find out manually what a project uses, or just choosing to fight with my editor preferences, I think it'd be better to use a conventional format that most editors support to handle it.

Reviewers shouldn't need to put out comments like:

Please adjust your editor settings to keep the current formatting.

#9 (comment)

How can this be tested?

N/A

Where to start code review?

N/A

Relevant tickets?

N/A

Questions?

N/A

@SethFalco SethFalco changed the title Chores chore: add .editorconfig Apr 3, 2023
@MasterOdin MasterOdin merged commit b489016 into tldr-pages:main Apr 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants