OpenRefine / OpenRefine/openrefine.org

Add a "Here be dragons" guide to the codebase

Open
#187 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
161
Forks
142
Avg merge
6h 10m
Merged PRs (30d)
9

Description

I came across this "Here be Dragons" guide to the Element code base and thought it was a nice thing to write and make available to contributors. We could have something similar for OpenRefine

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked “Here be Dragons” guide and the OpenRefine codebase to identify the contributor information worth documenting. Done means a comparable guide is written and made available on openrefine.org, with its location and scope clear to contributors.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.