chore: configure Prettier and EditorConfig for consistent formatting#694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

jeanpierrecarvalho wants to merge1 commit intoryanmcdermott:master

base:master

Choose a base branch

fromjeanpierrecarvalho:jpcarvalho/chore/format-readme-file

Open

chore: configure Prettier and EditorConfig for consistent formatting#694

jeanpierrecarvalho wants to merge1 commit intoryanmcdermott:masterfromjeanpierrecarvalho:jpcarvalho/chore/format-readme-file

Conversation

Copy link

jeanpierrecarvalho commentedOct 9, 2024

Configure Prettier and EditorConfig for Consistent README Formatting

Description

This configuration introduces Prettier and EditorConfig to enforce consistent formatting standards.

Changes Made:

Prettier: Added .prettierrc file
EditorConfig: Added new .editorconfig file
Reformatted theREADME.md file to comply with these new formatting rules.

Why These Changes are Necessary

Consistent formatting improves readability and reduces friction when working on documentation. By automating the enforcement of style rules, contributors can ensure documentation stays clean and standardized, regardless of the editor or environment they use.

Impact

No functional code changes: This PR strictly focuses on formatting and tooling, ensuring a consistent style across the documentation.
Improved developer experience: Automatic formatting saves time and reduces the likelihood of errors caused by manual formatting.

Checklist

Added Prettier configuration
Added EditorConfig configuration
ReformattedREADME.md according to the new formatting rules

How to Test

Install Prettier using the provided configuration.
Ensure your editor respects the EditorConfig settings.
Run Prettier to check that the formatting is applied correctly.

chore: configure Prettier and EditorConfig for consistent formatting

aed9b13

Copy link

Author

jeanpierrecarvalho commentedOct 9, 2024

Hi@ryanmcdermott,

Just created this PR for formatting the readme file. I will create some additional PRs for adding new features and probably a portuguese of Portugal version, and this will help to mantain consistency IMHO. What do you think?