msys2 / msys2/msys2-autobuild-controller
add meta-documentation for project
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
From @Biswa96 — 09/08/2022
Is it possible to add some documentation in that project?
- How does it work (without any technical jargon and in simple English)?
- How much secure is it?
- Which data does it collect from GitHub?
- Where are the data stored?
- How does it access GitHub user data?
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
No files, tests, or entry points are mentioned. Start by reviewing the project implementation and its GitHub workflow integration to determine how it works, what GitHub data it accesses, how data is stored, and the relevant security considerations. Done means adding clear, non-technical documentation that answers each question in the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100