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

Contributing guidelines. #36

Open
Gabisonfire opened this issue Feb 2, 2024 · 1 comment
Open

Contributing guidelines. #36

Gabisonfire opened this issue Feb 2, 2024 · 1 comment

Comments

@Gabisonfire
Copy link
Collaborator

Gabisonfire commented Feb 2, 2024

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?

@iPromKnight
Copy link
Collaborator

see #26
I included what I usually use for projects - it covers a lot of c# really, but will work for everything
We will probably want to customize a little as its tailored to my tastes lol

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

No branches or pull requests

2 participants