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

GitHub Action: Check Code Coverage Bypass Statements #2594

Closed
palisadoes opened this issue Dec 3, 2024 · 8 comments
Closed

GitHub Action: Check Code Coverage Bypass Statements #2594

palisadoes opened this issue Dec 3, 2024 · 8 comments
Assignees
Labels
good first issue Good for newcomers test Testing application

Comments

@palisadoes
Copy link
Contributor

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

  1. We take our commitment to high quality code seriously. We have test code coverage verification as part of our PR approval process.
  2. There is a .github/workflows/eslint_disable_check.py file that is run as part of our GitHub actions that checks submitted files for statements in the code base that bypass our linting verification.
  3. The Talawa-Admin code coverage levels are unusually high, because many contributors have used istanbul ignore statements. This does not create good code quality.
    1. https://github.com/gotwarlost/istanbul/blob/master/ignoring-code-for-coverage.md

Describe the solution you'd like

  1. We need a script similar to the .github/workflows/eslint_disable_check.py file that is run as part of our GitHub actions.
  2. The script must check submitted files for statements in the code base that bypass our code coverage verification.
  3. The script must be named .github/workflows/code_coverage_disable_check.py and must have the CLI option to be run against one or more directories using the --directory like the existing lint check script
  4. It must not check unit test files
  5. The script must be added to our develop and develop-postgres branches
  6. The script must be written in python3:
    1. python black, pydocstyle, pylint, pycodestyle and flake8 linting and formatting rules applied.

    2. It must follow the Google Python Code Style guide, especially the doc string formatting

      1. https://google.github.io/styleguide/pyguide.html#383-functions-and-methods

      image

Describe alternatives you've considered

  • N/A

Approach to be followed (optional)

  • See above

Additional context

  • N/A

Potential internship candidates

Please read this if you are planning to apply for a Palisadoes Foundation internship

@yashpandey06
Copy link

Hey would like to work on it since I am quite familiar with action work flows .

Can you help assign me this ?

@yashpandey06
Copy link

Hey @palisadoes like to work on it since I am quite familiar with action work flows .

Can you help assign me this ?

Copy link

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

@github-actions github-actions bot added the no-issue-activity No issue activity label Dec 15, 2024
@palisadoes
Copy link
Contributor Author

Unassigning. Inactivity

@github-actions github-actions bot removed the no-issue-activity No issue activity label Dec 16, 2024
@im-vedant
Copy link
Contributor

I would like to work on this issue.

@palisadoes
Copy link
Contributor Author

I would like to work on this issue.

Our policy is to assign no more than two issues to each contributor across all repositories. This way everyone gets a chance to participate in the projects. We sometimes give exceptions for more urgent cases and sometimes we lose track, but the policy stands. You have reached your limit, please wait until your existing issues are closed before requesting more issues. You could unassign yourself from one of the other issues too.

@im-vedant
Copy link
Contributor

im-vedant commented Dec 18, 2024

@palisadoes I have unassigned myself from one of the assigned issue. Can you assign me now?

@akshayw1
Copy link

Pls assign @palisadoes

@palisadoes palisadoes changed the title GitHub Action to Check Code Coverage Bypass Statementns GitHub Action: Check Code Coverage Bypass Statements Dec 26, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in Talawa-Admin (Tests) Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers test Testing application
Projects
Status: Done
Development

No branches or pull requests

5 participants