galaxyproject / galaxyproject/galaxy_codex
Add a comment on top of the generated file
Open
Beginner friendly
- Dominant language
- HTML
- Stars
- 28
- Forks
- 36
- Avg merge
- 19h 29m
- Merged PRs (30d)
- 1
Description
It would be clearer to add a comment on top of the generated files on
- how there were populated : script ...
- if there could be edited by human or if there will be overwrite by the CI
Contributor guide
Research direction
Start by locating the script that populates the generated files and inspect the generated-file headers. Add a comment explaining how each file was populated and whether human edits are preserved or overwritten by CI; done means the guidance appears at the top of the generated files.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100