-
Notifications
You must be signed in to change notification settings - Fork 83
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
DXCDT-64 Update docs #67
Conversation
@@ -0,0 +1,24 @@ | |||
; This file is for unifying the coding style for different editors and IDEs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this because I was opening the project with 2 different IDEs and they kept messing with each other.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, didn't know this was a thing!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wait, are these configurations what's causing the documentation format changes? How do we force that they're being applied without some type of pre-commit or lint checks?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most modern IDEs will automatically read the .editorconfig and apply the style changes without much user input. https://editorconfig.org/
8f18d0f
to
becc22e
Compare
@@ -0,0 +1,24 @@ | |||
; This file is for unifying the coding style for different editors and IDEs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wait, are these configurations what's causing the documentation format changes? How do we force that they're being applied without some type of pre-commit or lint checks?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still not 100% on board with the line-breaks but something I'm willing to concede on and just observe the pros/cons in due time. I also know this enforcement should work in theory, but still a bit skeptical in practice. But it serves as a good first iteration point that we can improve upon if we see the need.
Description
In this PR we are trying to improve our documentation:
Checklist
Note: Checklist required to be completed before a PR is considered to be reviewable.
Auth0 Code of Conduct
Auth0 General Contribution Guidelines
Changes include test coverage?
Does the description provide the correct amount of context?
Have you updated the documentation?
Is this code ready for production?