secureCodeBox / secureCodeBox/secureCodeBox
Generated Artifacts Should not be Committed into the Repo
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Go
- Stars
- 988
- Forks
- 184
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 42
Description
At the moment some artifacts (generated readmes and such) are committed into the repo. This leads to the problem that one accidentally fixes something in the generated artifact instead of the template.
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.
Research direction
Start by locating the generated README files and the templates that produce them. Determine how those artifacts enter the repository, then make the repository retain the templates without committing generated outputs; done means generated artifacts are no longer committed and template changes remain the source of truth.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100