platisd / platisd/bad-commit-message-blocker
add example yml for use in github and gitlab repos
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 65
- Forks
- 11
- Avg merge
- 31m
- Merged PRs (30d)
- 1
Description
It would be nice to have example config files for using this script in:
- github actions (currently part of the README)
- gitlab ci
- circleci
Not sure if its better to have them as part of the repository as files (it might be a pollution) or to have them as part of the README
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing GitHub Actions configuration in the README and inspect how the Python script is invoked. Add example configurations for GitHub Actions, GitLab CI, and CircleCI, deciding whether they belong as repository files or README sections. Done means all three platforms have usable examples and the chosen presentation is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100