Publish ZIM contribution guidelines

Open Beginner friendly
#100 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Domain
documentation

Research direction

Review the existing page at https://wiki.openzim.org/wiki/Contribute_a_ZIM_file and compare it with the issue's stated goal of documenting the ZIM contribution process. Confirm with the mentioned maintainers which additions are needed; the work is done when the page contains the agreed guidance and is accepted as the contribution reference.

Written by the indexing model from the issue text.

Description

enhancement

I've created https://wiki.openzim.org/wiki/Contribute_a_ZIM_file to document the ZIM contribution process.

It is in its infancy but I hope the most important things are already there.

@Popolechien @kelson42 @rgaudin please help me enhance this page or confirm it is OK for you.

Dominant language
HTML
Stars
9
Forks
2
PR merge metrics
No merged PRs in 30d

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.

More from openzim/overview

All issues in openzim/overview

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.