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 formatting guidelines #13

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sreekaransrinath
Copy link
Contributor

Closes #10

@sreekaransrinath
Copy link
Contributor Author

Switched from the wrong branch into a new one, oops.

@@ -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.
Copy link
Member

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?

Copy link
Member

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.

Copy link
Member

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.
Copy link
Member

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.
Copy link
Member

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

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

Successfully merging this pull request may close these issues.

contributor guidelines may need to prescribe formatting rules as well
3 participants