getsolus / getsolus/help-center-docs
Packaging Practices should have a section on making a patch
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 59
- Forks
- 93
- Avg merge
- 7h 38m
- Merged PRs (30d)
- 11
Description
The current documentation only covers applying a patch, which is of little help if the packager doesn't first know how to make a patch file in the first place.
The section should include the following steps:
- Clone the source repository
- Make changes to the source
- Create the patch file
i. Create a git commit detailing the changes
ii. Create (if not exists) thefilesdirectory inside the package's directory
iii. Rungit format-patch -o ~/path/to/package/dir/filesto create the patch file
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
Locate the Packaging Practices documentation and read the existing section about applying a patch. Add guidance covering source checkout, making changes, creating a commit, creating the package's files directory, and running the specified git format-patch command; the issue is complete when the section explains how to create a patch as well as apply one.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100