-
Notifications
You must be signed in to change notification settings - Fork 1
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 formatting guidelines #13
base: main
Are you sure you want to change the base?
Add formatting guidelines #13
Conversation
Switched from the wrong branch into a new one, oops. |
975065d
to
dc5610f
Compare
@@ -18,6 +18,8 @@ | |||
- Write meaningful commit messages and include the number (`#`) of the issue being resolved (if any) at the end of the commit message. | |||
|
|||
Example: `:bug: fix: Resolve 'isCorrect' function error (#0)` | |||
|
|||
- Format your code with [Prettier](https://prettier.io/), and set "printWidth" to 80. |
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.
Can you add the command as well to run it?
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.
- Also, I don't think mentioning the 'print width' is necessary, because if the extension is installed in let's say VS Code, the
.prettierrc
file in the project will automatically override the user's local settings. - The trailing
/
in the URL is unnecessary and should be removed IMO.
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.
How I had referred to Prettier in previous projects: github.com/HarshKapadia2/git_internals/blob/main/CONTRIBUTING.md
@@ -18,6 +18,8 @@ | |||
- Write meaningful commit messages and include the number (`#`) of the issue being resolved (if any) at the end of the commit message. | |||
|
|||
Example: `:bug: fix: Resolve 'isCorrect' function error (#0)` | |||
|
|||
- Format your code with [Prettier](https://prettier.io/), and set "printWidth" to 80. |
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.
- Also, I don't think mentioning the 'print width' is necessary, because if the extension is installed in let's say VS Code, the
.prettierrc
file in the project will automatically override the user's local settings. - The trailing
/
in the URL is unnecessary and should be removed IMO.
@@ -18,6 +18,8 @@ | |||
- Write meaningful commit messages and include the number (`#`) of the issue being resolved (if any) at the end of the commit message. | |||
|
|||
Example: `:bug: fix: Resolve 'isCorrect' function error (#0)` | |||
|
|||
- Format your code with [Prettier](https://prettier.io/), and set "printWidth" to 80. |
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.
How I had referred to Prettier in previous projects: github.com/HarshKapadia2/git_internals/blob/main/CONTRIBUTING.md
Closes #10