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

Improve Workflow #287

Open
bupd opened this issue Dec 17, 2024 · 1 comment
Open

Improve Workflow #287

bupd opened this issue Dec 17, 2024 · 1 comment
Labels
good first issue Good for newcomers

Comments

@bupd
Copy link
Member

bupd commented Dec 17, 2024

Workflows can be improved by adding

  1. documentation update check.
  2. lint and formatting
@bupd bupd added the good first issue Good for newcomers label Dec 17, 2024
@Roaster05
Copy link
Contributor

@bupd

Proposed Workflow Enhancements

  1. Documentation Update Check:

    • Add a new job in the workflow to detect changes in .md files or the docs/ directory.
    • The job should fail if no documentation changes are found when code changes require corresponding updates.
  2. Lint and Formatting:

    • Introduce a job to verify code formatting using gofmt or a similar tool, ensuring consistent style across the project.
    • Enhance the existing linting job by:
      • Installing and running golangci-lint to detect issues.
      • Using reviewdog for inline annotations in pull requests, improving error visibility and feedback.

Both enhancements should be integrated as prerequisites for other jobs like testing and building.

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
Projects
None yet
Development

No branches or pull requests

2 participants