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

Add some formatting guidelines #25

Closed
purple-emily opened this issue Feb 1, 2024 · 2 comments
Closed

Add some formatting guidelines #25

purple-emily opened this issue Feb 1, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@purple-emily
Copy link
Collaborator

With people contributing, everyones going to format the code slightly differently. I think adding something as simple as a .editorconfig file to the repo could make things a little more consistent.

There's also the option of adding some git hooks, but this would be a little more complicated.

An example .editorconfig could be something like:

# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

# Batch Files
[*.{cmd,bat}]
end_of_line = crlf

# JSON Files
[*.{json,json5,webmanifest}]
indent_size = 2

# YAML Files
[*.{yml,yaml}]
indent_size = 2

or we could set up something like pre-commit hook, but this will add some more dependencies to the project. Maybe a github workflow?

@Gabisonfire Gabisonfire self-assigned this Feb 1, 2024
@Gabisonfire Gabisonfire added the enhancement New feature or request label Feb 1, 2024
@Gabisonfire
Copy link
Collaborator

Good point. I'll think about the best way to do this.

@Gabisonfire
Copy link
Collaborator

Closed in favor of #36

@Gabisonfire Gabisonfire closed this as not planned Won't fix, can't repro, duplicate, stale Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants