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

Style guidelines #79

Closed
ChildishGiant opened this issue Mar 14, 2021 · 9 comments
Closed

Style guidelines #79

ChildishGiant opened this issue Mar 14, 2021 · 9 comments
Labels
enhancement New feature or request

Comments

@ChildishGiant
Copy link
Member

ChildishGiant commented Mar 14, 2021

Currently the project has a basic .eslintrc set up but I think it'd make contributing easier and more consistent if we opted to use js standard style. Many projects (including npm, GitHub and the UK government) use this style

@wuda-io
Copy link
Member

wuda-io commented Mar 17, 2021

From my point of view this is ok. What are the risks? Is it possible that some parts are not working then or is it just the style-formating of the code?

@Smankusors Smankusors added the enhancement New feature or request label Mar 17, 2021
@ChildishGiant
Copy link
Member Author

Most of the rules can be automatically fixed (and there's a very simple option to autofix everything). Some things cannot and would be highlight and need manually fixing (not too difficult)

@ChildishGiant
Copy link
Member Author

If we did our best to use conventional commit style that'd be a great help to future releases as changelogs could then be automatically generated. There are many tools for enforcing/suggesting this and also for making writing these commits as easy as possible.

@DanielRuf
Copy link

If we did our best to use conventional commit style that'd be a great help to future releases as changelogs could then be automatically generated. There are many tools for enforcing/suggesting this and also for making writing these commits as easy as possible.

Should we apply commitlint using https://www.npmjs.com/package/husky?

ChildishGiant added a commit to ChildishGiant/materialize that referenced this issue Apr 29, 2021
ChildishGiant added a commit to ChildishGiant/materialize that referenced this issue May 2, 2021
@wuda-io wuda-io closed this as completed May 12, 2021
@ChildishGiant
Copy link
Member Author

The issue is about code style, not just commit style, I don't think it can be closed yet.

@DanielRuf DanielRuf reopened this May 12, 2021
bugy pushed a commit to bugy/materialize that referenced this issue Oct 3, 2021
@wuda-io
Copy link
Member

wuda-io commented Nov 3, 2022

Can we close it now? The conventional commit style is now enforced via Husky. Please confirm and/or close.

@LoganTann
Copy link

Can we close it now? The conventional commit style is now enforced via Husky. Please confirm and/or close.

As said in the comment above, this original issue is about enforcing the code style (indentation, etc.), not only the commit message format.

@wuda-io
Copy link
Member

wuda-io commented Nov 4, 2022

Ah sorry, my misktake. Didnt read properly. As far as i remember, there was a automatic code styling applied though, when i was writing some changes. Maybe it was serverside at CI Level.

@wuda-io
Copy link
Member

wuda-io commented Dec 18, 2023

Hello @ChildishGiant
Now I understand what you meant. Sorry for that. I saw that there is a devDependency installed (prettier).
I also use prettier locally.
I think we can create a prettier Configuration file locally for VSCode so that we all have the same code styles applied.
But I think it is overpowered to use it server-side (via GH Actions)
What do you think?

PS: Where are you all? 😆 Hope you all are doing fine and thank you all for starting Materialize.

@wuda-io wuda-io closed this as not planned Won't fix, can't repro, duplicate, stale Aug 29, 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

5 participants