Skip to content

Workflow: Add a New GitHub Actions Workflow #11

@milansinghal2004

Description

@milansinghal2004

Description

To help us maintain code quality and automate repetitive tasks, we would like to add a new GitHub Actions workflow to this repository. Automations ensure that all contributions are consistent and help the maintainers by running checks automatically.

We are open to different ideas, but a great first step would be a workflow that runs a linter (like Flake8 or Black) on every new pull request to check for code style and errors.

Tasks

  • Create a new workflow file inside the .github/workflows/ directory (e.g., linter.yml).
  • Write the YAML code for the workflow. It should trigger on every pull request.
  • The workflow should check out the code, set up Python, install dependencies, and run the linter command.
  • Add a section to the README.md explaining what the new automation does and how it works.

Acceptance Criteria

  • The new workflow successfully runs on all new pull requests.
  • It correctly reports a "pass" or "fail" status.
  • The README.md is updated with documentation for the new workflow.

If you have another idea for a useful workflow (e.g., running tests, auto-labeling issues), please suggest it in the comments! Don't forget to review our CONTRIBUTING.md.

Metadata

Metadata

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions