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

Create a wiki page for linters used by the HfLA website team #3230

Open
10 tasks
SAUMILDHANKAR opened this issue Jun 7, 2022 · 2 comments
Open
10 tasks

Create a wiki page for linters used by the HfLA website team #3230

SAUMILDHANKAR opened this issue Jun 7, 2022 · 2 comments
Labels
Complexity: Large Dependency An issue is blocking the completion or starting of another issue Feature: Wiki role: back end/devOps Tasks for back-end developers size: 2pt Can be done in 7-12 hours

Comments

@SAUMILDHANKAR
Copy link
Member

SAUMILDHANKAR commented Jun 7, 2022

Dependency

Overview

As a developer, I would like critical processes to be documented in a wiki page. In this issue, we will create a wiki page with details about how linters are being used in our repo.

Action Items

  • Explore how wiki pages are organized in our repo.
  • Decide which section would be appropriate for this new wiki page.
  • Understand linter architecture in the following document: GHA architecture notes spreadsheet
  • Create a new wiki page and include a brief section on how linters work in general.
  • List all the linters being used in our repo as well as the workflows related to linters. For example: Lint SCSS
  • For each linter, add the following information:
    • When does the workflow get triggered
    • Discuss a workflow scenario and next steps for when the linter catches an error.
    • Discuss a workflow scenario for when the linter runs with no error.
  • Since no PR would be needed for this issue, once all action items are done, reach out to the leads or merge team members for a review.

Resources/Instructions

@SAUMILDHANKAR SAUMILDHANKAR added role: back end/devOps Tasks for back-end developers Complexity: Large Feature: Wiki size: 2pt Can be done in 7-12 hours labels Jun 7, 2022
@github-actions

This comment was marked as resolved.

@SAUMILDHANKAR SAUMILDHANKAR changed the title Create a wiki page for how linters are being used in our repo Create a wiki page for linters are in our repo Jun 10, 2022
@SAUMILDHANKAR SAUMILDHANKAR changed the title Create a wiki page for linters are in our repo Create a wiki page for linters used by the HfLA website team Jun 10, 2022
@SAUMILDHANKAR SAUMILDHANKAR added the Dependency An issue is blocking the completion or starting of another issue label Jun 10, 2022
@JessicaLucindaCheng
Copy link
Member

This issue needs to be edited by a lead to reflect our migration to the website-wiki repo. For more info, read How to Contribute to the Wiki.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Large Dependency An issue is blocking the completion or starting of another issue Feature: Wiki role: back end/devOps Tasks for back-end developers size: 2pt Can be done in 7-12 hours
Projects
Development

No branches or pull requests

3 participants