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

.editorconfig: add EditorConfig #20746

Merged
merged 1 commit into from
Jun 14, 2024
Merged

.editorconfig: add EditorConfig #20746

merged 1 commit into from
Jun 14, 2024

Conversation

maribu
Copy link
Member

@maribu maribu commented Jun 11, 2024

Contribution description

This adds an EditorConfig file in the root of the repo. Most editors support it natively or via a plugin.

This is particularly useful for occasional contributors, who with this no longer need to configure the editor to properly show and format source code.

Testing procedure

Open/edit a source file in the PR branch with one of the supported editors. The format should match the coding convention out of the box.

Issues/PRs references

None

@maribu maribu added Type: new feature The issue requests / The PR implemements a new feature for RIOT CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Area: tools Area: Supplementary tools CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Jun 11, 2024
@github-actions github-actions bot removed the Area: tools Area: Supplementary tools label Jun 11, 2024
@riot-ci
Copy link

riot-ci commented Jun 11, 2024

Murdock results

✔️ PASSED

c7b9445 .editorconfig: add EditorConfig

Success Failures Total Runtime
1 0 1 01m:17s

Artifacts

Copy link
Member

@dylad dylad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, except the Makefile size maybe ?

.editorconfig Outdated
[{Makefile*,*.mk}]
indent_style = tab
indent_size = 4
tab_size = 4
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we have a tab_size policy of 2 for Makefile ?

This adds an [EditorConfig][homepage] file in the root of the repo. Most
editors support it [natively][native-support] or via a
[plugin][plugin-support].

This is particularly useful for occasional contributors, who with this
no longer need to configure the editor to properly show and format
source code.

[homepage]: https://editorconfig.org/
[native-support]: https://editorconfig.org/#pre-installed
[plugin-support]: https://editorconfig.org/#download
Copy link
Member

@dylad dylad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK.
Let's hope it helps.

@dylad dylad added this pull request to the merge queue Jun 14, 2024
Merged via the queue into RIOT-OS:master with commit b40c787 Jun 14, 2024
26 checks passed
@maribu maribu deleted the editorconfig branch June 16, 2024 11:00
@mguetschow mguetschow added this to the Release 2024.07 milestone Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: new feature The issue requests / The PR implemements a new feature for RIOT
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants