Document a blessed way to ship patched modules
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description of Issue/Question
The currently flow when a bug is found in a bundled module:
- Track down bug, write fix
- Submit PR, do PR things, PR is accepted
- Wait for the next release (frequently long)
- Update salt and enjoy your bug fix
As an employee trying to Get Things Done, steps 1 and 2 are frequently not bad. But the wait for those fixes to be made available and usable is often quite long, and the work-arounds in the mean time are very annoying.
There should a well-established method to ship patched modules, preferably in my salt states. (Instead of, like, having to repackage salt and ship patched packages.)
Versions Report
All versions affected.
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
The issue names no files, tests, or entry points. Start by tracing how bundled modules are loaded and how Salt states can currently install or override them, then compare that with the release flow described. Done means a maintainer-approved workflow for shipping patched modules is documented and its limitations are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- infrastructure
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100