easystats / easystats/workflows
Add workflow for miscellaneous extra checks
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 9
- Forks
- 3
- Avg merge
- 5h 51m
- Merged PRs (30d)
- 4
Description
Will keep updating as I think of some other common issues and, once there are enough of these, build a workflow around it.
- To detect exported functions that don't have return values in the docs (using
find_missing_tags()); currently enforced by CRAN only for new submissions, but this might change in the future
### Tasks
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 by reading the linked find_missing_tags() reference and reviewing how the repository's workflows are organized. Define the workflow scope around detecting exported functions without return-value documentation, and consider how the planned collection of miscellaneous checks should remain extensible; done means this check is automated and its expected result is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, r
- Domain
- ci-cd
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100