Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (22 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.1 KB
Raw

Contributing

Thanks for helping improve Mimicker Action!

Prerequisites

  • Git
  • A GitHub account

How to contribute

  1. Fork the repo and create a branch from main
  2. Make your changes to action.yml, README.md, or the test workflow
  3. Test locally by pushing to a fork and running the workflow
  4. Open a PR against main — CI will run automatically

Testing changes

The test workflow (.github/workflows/test.yml) runs two jobs:

  • Test — no stubs file: starts Mimicker with no config and checks the health endpoint
  • Test — with stubs file: starts Mimicker with a YAML config, hits a stub, and runs the coverage report

To test your changes, push to your fork and trigger the workflow via workflow_dispatch or a push to main.

Reporting bugs

Open an issue with:

  • The action.yml inputs you used
  • The full workflow step output
  • Expected vs actual behavior

Questions

Open a Discussion or check the Mimicker docs.