OpenRefine / OpenRefine/openrefine.org
Move CONTRIBUTING.MD content to the website/documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 161
- Forks
- 142
- Avg merge
- 6h 10m
- Merged PRs (30d)
- 9
Description
Following the last round of edits in GOVERNANCE.MD https://github.com/OpenRefine/OpenRefine/pull/6737 @wetneb proposed to:
- improve the documentation on the website with whatever information is in CONTRIBUTING.md and not there yet
- change CONTRIBUTING.md to be a redirection to the website as suggested below
Thank you for your interest in contributing to OpenRefine! Our documentation for new contributors is at:
https://openrefine.org/docs/technical-reference/contributing
Originally posted by @wetneb in https://github.com/OpenRefine/OpenRefine/issues/6737#issuecomment-2282706320 - edited by @magdmartin
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 CONTRIBUTING.md with the contributor documentation at https://openrefine.org/docs/technical-reference/contributing, identifying information present in the former but missing from the website. Update the website documentation with that content, then replace CONTRIBUTING.md with the specified redirect text. Done means the relevant guidance is available on the website and the repository file points contributors there.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100