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

strict lint and update PR workflow #1673

Closed
wants to merge 3 commits into from

Conversation

lakshz
Copy link

@lakshz lakshz commented Mar 5, 2024

What kind of change does this PR introduce?
Stricts the lint config to consider no-explicit-any as an error.

Updated PR workflow:

  • Linting Checks in PR, will be done only on changed-files

Updated pre-commit script:

  • lint-staged configuration was added in package.json file, taking help talawa-api project.

Issue Number:

Fixes #1427

Did you add tests for your changes?

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?

@lakshz lakshz requested a review from palisadoes as a code owner March 5, 2024 19:54
Copy link

github-actions bot commented Mar 5, 2024

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link

codecov bot commented Mar 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.39%. Comparing base (2b82ebf) to head (46a613f).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1673      +/-   ##
===========================================
- Coverage    97.41%   97.39%   -0.02%     
===========================================
  Files          164      168       +4     
  Lines         4058     4148      +90     
  Branches      1177     1210      +33     
===========================================
+ Hits          3953     4040      +87     
- Misses         101      104       +3     
  Partials         4        4              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Cioppolo14 Cioppolo14 removed the request for review from palisadoes March 6, 2024 02:44
@Cioppolo14
Copy link

@lakshz Please fill out the PR template as thoroughly as possible. In the future, please do not assign reviewers. We have queue monitors who do an initial check of the PR, and then assign reviewers when it is ready.

@Cioppolo14
Copy link

@Tajcore @beingnoble03 Can you review this PR?

@lakshz
Copy link
Author

lakshz commented Mar 6, 2024

@Cioppolo14 Got it, I updated the PR comment.
Apologies for any confusion. I wanted to clarify that my pull request was automatically assigned to Palisadoes for review, as he is the designated code owner.

@lakshz
Copy link
Author

lakshz commented Mar 6, 2024

Screenshot 2024-03-06 at 18 03 59

I want to highlight that, if we strict the lint of no-explicit-any, the project will be functionally same, but it will show lint errors on running.

Solution to this, would be to first migrate the codebase with no any, and then strict the lint.

@palisadoes
Copy link
Contributor

  1. This PR needs to be closed. The source and target PR branches are the same. This means that our reviewers will not be able to checkout the changes and test on their systems using this methodology which will cause a rejection error:
    1. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally
  2. Please create a new branch in your local repository with the changes
  3. Make sure the branch name is named differently from the target branch (develop)
  4. Resubmit your PR

You will see that other PRs are using non-develop branch names for this reason

@palisadoes palisadoes closed this Mar 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants