feat: Document the CI workflow in the README/as an MD file
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- github-actions
- Domain
- cli, documentation
Research direction
Read the README and inspect the existing workflow files under .github/workflows/ to use the repository's working CI setup as the reference. The work is done when the README includes a CI usage section with a GitHub Actions example that makes running rocale-cli in a CI pipeline actionable.
Written by the indexing model from the issue text.
Description
Problem
The README covers local installation and basic usage, but gives no guidance on how to use rocale-cli in a CI environment. The devforum announcement explicitly calls out CI pipelines as a primary use case:
"Managing a large repo? Run automated tests and verification in your team's CI pipelines on GitHub Actions and beyond."
New adopters have no example to follow.
Proposed solution
Add a "CI usage" section to the README with a GitHub Actions example. The repo already has a working CI workflow in .github/workflows/ that can serve as the basis so this is purely a docs change, no new functionality needed.
Why this matters
A CI example in the README removes the biggest friction point for new users wanting to utilise it in production workflows. It also makes the "CI pipelines" use case from the devforum announcement actually actionable for developers reading the docs for the first time.
- Dominant language
- Luau
- Stars
- 34
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Contributor guide
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.
More from Roblox/rocale-cli
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
Roblox/rocale-cli#31 ·
All issues in Roblox/rocale-cli
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
from:qa priority:P2 reliability tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
spec-kitty/spec-kitty#4874 ·
-
0. Needs triage bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
nextcloud/fulltextsearch#1011 ·
-
automation code-quality cookie deep-report documentation improvement quick-win task-mining
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100