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 workflows to improve the ease of open source contributions. #158

Open
7 tasks
another-rex opened this issue Aug 30, 2024 · 6 comments
Open
7 tasks

Add workflows to improve the ease of open source contributions. #158

another-rex opened this issue Aug 30, 2024 · 6 comments

Comments

@another-rex
Copy link
Collaborator

another-rex commented Aug 30, 2024

Non-exhaustive list of workflows to add:

  • golang-ci-lint
  • Unit tests
  • Integration tests
  • codeql analysis
  • vulnerability scanner (osv-scanner-action)
  • scorecard
  • Issue bot explaining the workflow.
@erikvarga
Copy link
Collaborator

When it comes to unit tests we have the github actions that run the unit tests for linux and windows on every PR - is there anything else we'd need there?

@another-rex
Copy link
Collaborator Author

I think unit tests are covered, I missed those when initially writing this. Though I think we need to add macOS as a platform to test as well?

@another-rex
Copy link
Collaborator Author

another-rex commented Sep 2, 2024

Also need to add

  • docstring lint, all public functions and packages need docstrings.

@ansh-devs
Copy link

ansh-devs commented Sep 7, 2024

Also need to add

  • docstring lint, all public functions and packages need docstrings.

Hi @another-rex @erikvarga can i pick this one up ?

@another-rex
Copy link
Collaborator Author

Sure, my original idea is to configure golangci-lint to perform this lint, but turns out to be harder to enable than expected: golangci/golangci-lint#456

@ansh-devs
Copy link

So , then what's your uptake on this ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants