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

Add CI for Linting and Code Coverage #11

Open
2 of 6 tasks
vhespanha opened this issue Aug 17, 2024 · 3 comments
Open
2 of 6 tasks

Add CI for Linting and Code Coverage #11

vhespanha opened this issue Aug 17, 2024 · 3 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed refactor Code needs refactoring
Milestone

Comments

@vhespanha
Copy link

vhespanha commented Aug 17, 2024

(I promise this is my last issue today.)

Description

I'm primarily opening this issue so it can be better tracked, since I'm already working on it for the past day or so. I also think it should be added to the milestone since this will make for a better DX for new contributors.

I decided to switch linters for the project to cover more cases and implement GitHub Actions for it. In this process, I found a lot of linting warnings that should probably be addressed before we can enforce them on the repo. Most of them will be fixed in the following PR, but others will need a little more thinking and big changes, which will be better suited for separate PRs or even issues (like #10).

My strategy will be to:

  • Fix the simpler linting warnings in the following PR.
  • Address other warnings through their respective issues.
  • Implement testing for the whole repo (help wanted, I'm terrible with tests).
  • Finally, implement CI for the new linter and to check code coverage by tests.

Benefits

  • Automated Linting: Automatically check for code errors and formatting issues.
  • Code Coverage: Measure the percentage of code covered by tests to identify untested areas.
  • Consistency: Ensure that all code changes meet our quality standards before merging.
  • Better DX: Improve the developer experience for new contributors.

Tasks

(@d4r1us-drk, feel free to edit this to add or remove something, or to assign people to any task)

  • Switch to a new linter that covers more cases.
  • Fix simpler linting warnings in the next PR.
  • Address more complex linting warnings through separate PRs or issues.
  • Implement testing for the entire repo.
  • Set up a GitHub Actions workflow for linting.
  • Set up a GitHub Actions workflow for code coverage.
@d4r1us-drk d4r1us-drk added this to the v1.1 milestone Aug 17, 2024
@d4r1us-drk d4r1us-drk added enhancement New feature or request help wanted Extra attention is needed refactor Code needs refactoring labels Aug 17, 2024
@d4r1us-drk
Copy link
Owner

Implement testing for the whole repo (help wanted, I'm terrible with tests).

I am too lmao

@d4r1us-drk
Copy link
Owner

I will try to get more contributors and help on Mastodon and asking friends

@vhespanha
Copy link
Author

Another task completed! #14

@d4r1us-drk d4r1us-drk pinned this issue Sep 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed refactor Code needs refactoring
Projects
None yet
Development

No branches or pull requests

2 participants