Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: configure Prettier and EditorConfig for consistent formatting #694

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jeanpierrecarvalho
Copy link

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 the README.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
  • Reformatted README.md according to the new formatting rules

How to Test

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

@jeanpierrecarvalho
Copy link
Author

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?

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.

2 participants