getsolus / getsolus/help-center-docs
Fix conflicting information about updating a package with a maintainer
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 59
- Forks
- 93
- Avg merge
- 7h 38m
- Merged PRs (30d)
- 11
Description
In Matrix, someone pointed out an inconsistency in our docs that caused some confusion.
According to the documentation help.getsol.us/docs/packaging/update-an-existing-package, it says that if a package already has a maintainer, I should reach out to her/him directly to update the package. However, help.getsol.us/docs/packaging/procedures/maintainership/ states that I should either open a package update request or ask for permission here.
We should make the instructions on both pages consistent. Consider doing so with an include or separate page to keep all the text in one place, to avoid this confusion in the future.
Also, consider:
- What to do if the person has no Matrix info (only email)
- If the person has a Matrix account, detail what we mean by "reach out" - e.g. ping in the packaging channel (avoid suggesting DMs since some folks are iffy about random DMs from unknown people)
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
Compare the instructions at help.getsol.us/docs/packaging/update-an-existing-package and help.getsol.us/docs/packaging/procedures/maintainership/, then inspect the repository structure for their source files and any existing include pattern. Make the guidance consistent, clarify Matrix and email contact options without recommending unsolicited DMs, and verify both pages render with the same instructions.
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
- 70/100