Improvement/GDL-12-add-prettier-config by benzekrimaha · Pull Request #211 · scality/Guidelines

benzekrimaha · 2026-03-09T15:42:35Z

bert-e · 2026-03-09T15:42:39Z

Hello benzekrimaha,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Available options

name	description	privileged	authored
`/after_pull_request`	Wait for the given pull request id to be merged before continuing with the current one.
`/bypass_author_approval`	Bypass the pull request author's approval	⭐
`/bypass_build_status`	Bypass the build and test status	⭐
`/bypass_commit_size`	Bypass the check on the size of the changeset `TBA`	⭐
`/bypass_incompatible_branch`	Bypass the check on the source branch prefix	⭐
`/bypass_jira_check`	Bypass the Jira issue check	⭐
`/bypass_peer_approval`	Bypass the pull request peers' approval	⭐
`/bypass_leader_approval`	Bypass the pull request leaders' approval	⭐
`/approve`	Instruct Bert-E that the author has approved the pull request.		✍️
`/create_pull_requests`	Allow the creation of integration pull requests.
`/create_integration_branches`	Allow the creation of integration branches.
`/no_octopus`	Prevent Wall-E from doing any octopus merge and use multiple consecutive merge instead
`/unanimity`	Change review acceptance criteria from `one reviewer at least` to `all reviewers`
`/wait`	Instruct Bert-E not to run until further notice.

Available commands

name	description	privileged
`/help`	Print Bert-E's manual in the pull request.
`/status`	Print Bert-E's current status in the pull request `TBA`
`/clear`	Remove all comments from Bert-E from the history `TBA`
`/retry`	Re-start a fresh build `TBA`
`/build`	Re-start a fresh build `TBA`
`/force_reset`	Delete integration branches & pull requests, and restart merge process from the beginning.
`/reset`	Try to remove integration branches unless there are commits on them which do not appear on the source branch.

Status report is not available.

Issue: GDL-12

This commit defines line ending/newline defaults and per-file indentation rules so local editors match the shared Prettier policy across JS/TS, JSON, YAML, Markdown, and Makefiles. Issue: GDL-12

This commit upldate the documentation to explain the new Prettier baseline, recommended adoption steps, and editor alignment so downstream repositories can import and apply the config consistently. Issue: GDL-12

bert-e · 2026-03-09T15:50:19Z

Request integration branches

Waiting for integration branch creation to be requested by the user.

To request integration branches, please comment on this pull request with the following command:

/create_integration_branches

Alternatively, the /approve and /create_pull_requests commands will automatically
create the integration branches.

francoisferrand · 2026-03-09T17:01:11Z

.editorconfig

+indent_style = space
+indent_size = 4
+
+[Makefile]


Also applies to golang (which we have in our code base, and would thus be affected by a .editorconfig file)

Suggested change

[Makefile]

[{Makefile,*.go,go.*}]

francoisferrand · 2026-03-09T17:01:56Z

.editorconfig

+indent_size = 4
+
+[Makefile]
+indent_style = tab


Should also specify indent_size (for alignment) ?

Suggested change

indent_style = tab

indent_style = tab

indent_size = 4

francoisferrand · 2026-03-09T17:04:59Z

.editorconfig

+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true


Suggested change

trim_trailing_whitespace = true

trim_trailing_whitespace = true

max_line_length = 120

(or maybe should only be set for javascript files, e.g. around line 11)

francoisferrand · 2026-03-09T17:08:12Z

.editorconfig

+indent_style = space
+indent_size = 4


nit: instead of repeating indent style & size for each kind of file, we may put this in the * block and override it only where needed (to reduce duplication)

francoisferrand · 2026-03-09T17:08:58Z

README.md

+   }
+   ```
+
+Projects are free to override options locally (for example `tabWidth` or


Suggested change

Projects are free to override options locally (for example `tabWidth` or

Projects may override options locally (for example `tabWidth` or

francoisferrand · 2026-03-09T17:11:16Z

README.md

+Node.js codebases. YAML defaults to 2-space indentation, JSON and Markdown to
+4-space indentation, and Markdown prose is left un-reflowed by default
+(`proseWrap: 'preserve'`) to avoid noisy diffs in existing documentation.


this paraphrases the content of the config, so does not add much value but creates a risk of being outdated: best leave it out?

Suggested change

Node.js codebases. YAML defaults to 2-space indentation, JSON and Markdown to

4-space indentation, and Markdown prose is left un-reflowed by default

(`proseWrap: 'preserve'`) to avoid noisy diffs in existing documentation.

Node.js codebases.

francoisferrand · 2026-03-09T17:11:37Z

README.md

+
+## Editor configuration
+
+For a consistent editor experience, you can copy or adapt the `.editorconfig`


Suggested change

For a consistent editor experience, you can copy or adapt the `.editorconfig`

For a consistent editor experience, you can copy the `.editorconfig`

francoisferrand · 2026-03-09T17:14:53Z

README.md

+4-space indentation, and Markdown prose is left un-reflowed by default
+(`proseWrap: 'preserve'`) to avoid noisy diffs in existing documentation.
+
+## Editor configuration


do we actually need (and recommend) using editorconfig ?

AFAIK there is currently not much problem, editors (like vscode) already follow the code appropriately

since we need to copy the file, it creates an independent copy, which may diverge over time... and we have no way to check consistency with the "original" in Guidelines (or should we have a postscript to copy the .editorconfig from guideline module to the root of the repo importing it?)

→ either it is needed, and we should recommend to use it ("For a consistent editor experience, you should copy the .editorconfig...)
→ or it is not needed, and there is no need to mention it

Reduce editorconfig duplication, add Go/Makefile tab alignment and max line length, and tighten README wording to avoid config drift and clarify .editorconfig recommendation.

benzekrimaha force-pushed the improvement/GDL-12-add-new-prettier-config branch from 42093e9 to 6749be6 Compare March 9, 2026 15:44

benzekrimaha added 3 commits March 9, 2026 16:45

Add shared Prettier baseline config.

8d04c2f

Issue: GDL-12

Add editorconfig aligned with shared formatting baseline.

f85716f

This commit defines line ending/newline defaults and per-file indentation rules so local editors match the shared Prettier policy across JS/TS, JSON, YAML, Markdown, and Makefiles. Issue: GDL-12

Document how to consume the shared formatting baseline.

2fb532e

This commit upldate the documentation to explain the new Prettier baseline, recommended adoption steps, and editor alignment so downstream repositories can import and apply the config consistently. Issue: GDL-12

benzekrimaha force-pushed the improvement/GDL-12-add-new-prettier-config branch from 6749be6 to 2fb532e Compare March 9, 2026 15:47

scality deleted a comment from bert-e Mar 9, 2026

benzekrimaha marked this pull request as ready for review March 9, 2026 15:50

benzekrimaha changed the title ~~Improvement/gdl 12 add new prettier config~~ Improvement/GDL-12-add-prettier-config Mar 9, 2026

francoisferrand reviewed Mar 9, 2026

View reviewed changes

Address formatting baseline review feedback.

bceec6f

Reduce editorconfig duplication, add Go/Makefile tab alignment and max line length, and tighten README wording to avoid config drift and clarify .editorconfig recommendation.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improvement/GDL-12-add-prettier-config#211

Improvement/GDL-12-add-prettier-config#211
benzekrimaha wants to merge 4 commits intodevelopment/8.2from
improvement/GDL-12-add-new-prettier-config

benzekrimaha commented Mar 9, 2026 •

edited

Loading

Uh oh!

bert-e commented Mar 9, 2026

Uh oh!

bert-e commented Mar 9, 2026

Uh oh!

francoisferrand Mar 9, 2026 •

edited

Loading

Uh oh!

francoisferrand Mar 9, 2026 •

edited

Loading

Uh oh!

francoisferrand Mar 9, 2026 •

edited

Loading

Uh oh!

francoisferrand Mar 9, 2026

Uh oh!

francoisferrand Mar 9, 2026 •

edited

Loading

Uh oh!

francoisferrand Mar 9, 2026

Uh oh!

francoisferrand Mar 9, 2026

Uh oh!

francoisferrand Mar 9, 2026

Uh oh!

francoisferrand Mar 9, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	trim_trailing_whitespace = true
	trim_trailing_whitespace = true
	max_line_length = 120

	Projects are free to override options locally (for example `tabWidth` or
	Projects may override options locally (for example `tabWidth` or


		## Editor configuration

		For a consistent editor experience, you can copy or adapt the `.editorconfig`

Conversation

benzekrimaha commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bert-e commented Mar 9, 2026

Hello benzekrimaha,

Uh oh!

bert-e commented Mar 9, 2026

Request integration branches

Uh oh!

francoisferrand Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

francoisferrand Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

francoisferrand Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

francoisferrand Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

francoisferrand Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

francoisferrand Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

francoisferrand Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

francoisferrand Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

francoisferrand Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

benzekrimaha commented Mar 9, 2026 •

edited

Loading

francoisferrand Mar 9, 2026 •

edited

Loading

francoisferrand Mar 9, 2026 •

edited

Loading

francoisferrand Mar 9, 2026 •

edited

Loading

francoisferrand Mar 9, 2026 •

edited

Loading

francoisferrand Mar 9, 2026 •

edited

Loading