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 to Check Code Coverage Bypass Statementns #2594

Open
palisadoes opened this issue Dec 3, 2024 · 2 comments
Open

GitHub Action to Check Code Coverage Bypass Statementns #2594

palisadoes opened this issue Dec 3, 2024 · 2 comments
Assignees
Labels
feature request 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 ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request good first issue Good for newcomers test Testing application
Projects
Status: Backlog
Development

No branches or pull requests

3 participants