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.

Sign up for GitHub

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

Jump to bottom

Add code linter and formatter to enhance code quality and maintain consistency #55

Closed
Amulya-coder opened this issue Mar 23, 2021 · 3 comments · Fixed by #67
Closed

Add code linter and formatter to enhance code quality and maintain consistency #55

Amulya-coder opened this issue Mar 23, 2021 · 3 comments · Fixed by #67
Assignees
@Aryamanz29
Labels
Category: Coding Changes to code base or refactored code that doesn't fix a bug. Category: Quality Assurance Changes to code or files that improve testing or fixes bugs. open source hack

Comments

@Amulya-coder
Copy link
Member

Amulya-coder commented Mar 23, 2021 •
edited
Loading

Is your feature request related to a problem? Please describe.

It is necessary for a project to have clear consistent coding conventions. Besides that linting is also very helpful for finding certain classes of bugs and fixing them before runtime.

Describe the solution you'd like

Eslint and Prettier is the most popular code linter and formatter for Javascript.

  • Integrate Eslint into the project
  • Integrate Prettier into the project
  • Make Eslint work with prettier i.e. Eslint for linting and Prettier for formatting code
  • Add a brief description about them in the project readme.
  • Add Github workflows to ensure the guidelines are followed by every contributor.

Additional context

This is also used in anitab-forms-web you can take reference from that.
@Amulya-coder
Copy link
Member Author

@annabauza can you please approve this issue.

@Aaishpra Aaishpra added Category: Coding Changes to code base or refactored code that doesn't fix a bug. Status: Available Issue was approved and available to claim or abandoned for over 3 days. labels Mar 30, 2021
@Amulya-coder Amulya-coder added Category: Quality Assurance Changes to code or files that improve testing or fixes bugs. and removed Category: Coding Changes to code base or refactored code that doesn't fix a bug. labels Mar 31, 2021
@jalajcodes jalajcodes added Category: Coding Changes to code base or refactored code that doesn't fix a bug. open source hack labels Apr 3, 2021
@Aryamanz29
Copy link
Contributor

@Amulya-coder I would like to work on this

@Amulya-coder
Copy link
Member Author

@Aryamanz29 Please go ahead

@Amulya-coder Amulya-coder removed the Status: Available Issue was approved and available to claim or abandoned for over 3 days. label Apr 12, 2021
Aryamanz29 added a commit to Aryamanz29/stem-diverse-tv-cms that referenced this issue Apr 15, 2021
@Aryamanz29
QA : Added linter,formatter and Workflow (anitab-org#55)
f9ad4d2 
Closes anitab-org#55
Aryamanz29 added a commit to Aryamanz29/stem-diverse-tv-cms that referenced this issue Apr 15, 2021
@Aryamanz29
QA: Added linter,Formatter & Workflow (anitab-org#55)
d189060 
closes anitab-org#55
Aryamanz29 added a commit to Aryamanz29/stem-diverse-tv-cms that referenced this issue Apr 15, 2021
@Aryamanz29
QA: Added linter,Formatter & Workflow (anitab-org#55)
97c219b 
closes anitab-org#55
@Aryamanz29 Aryamanz29 mentioned this issue Apr 15, 2021
Merged
11 tasks
@Rahulm2310 Rahulm2310 mentioned this issue Apr 16, 2021
Open
Aryamanz29 added a commit to Aryamanz29/stem-diverse-tv-cms that referenced this issue Apr 29, 2021
@Aryamanz29
QA: Added linter,Formatter & Workflow (anitab-org#55)
2c08ae4 
closes anitab-org#55
annabauza pushed a commit that referenced this issue Jun 6, 2021
@Aryamanz29
QA: Added linter,Formatter & Workflow (#55) (#67)
72a724d 
* QA: Added linter,Formatter & Workflow (#55)
closes #55

* Update: deps and upstream
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Aryamanz29 Aryamanz29

Labels
Category: Coding Changes to code base or refactored code that doesn't fix a bug. Category: Quality Assurance Changes to code or files that improve testing or fixes bugs. open source hack
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

QA: Added linter,Formatter & Workflow (#55) Aryamanz29/stem-diverse-tv-cms
4 participants
@jalajcodes @Aryamanz29 @Aaishpra @Amulya-coder