Update "How to contribute" for Wiki changes
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 11.9k
- Forks
- 1.5k
- Avg merge
- 17h 55m
- Merged PRs (30d)
- 3
Description
Hey Shopifolks, I was looking to add the following two entries to the wiki:
Unfortunately, the contributing guidelines don't really say how to contribute to the wiki and Github doesn't provide a clear workflow for pull requests around wiki repos.
What's the best way to offer changes to the wiki?
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 with CONTRIBUTING.md at the linked revision and the wiki's "Who uses Liquid" section. Clarify the supported workflow for proposing wiki changes, then document that workflow in CONTRIBUTING.md; done means contributors can understand how to offer wiki updates, including the two entries mentioned.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100