RexOps / RexOps/Rex

the README should be generated from Rex.pm

Open
#862 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Perl
Stars
737
Forks
214
PR merge metrics
No merged PRs in 30d

Description

The pod for Rex.pm is the thing people see first on metacpan.org. It is the starting point for perl people. the README.md is the thing people see first on github. It is also a starting point for github people. It would make sense if those starting points were the same and presented the same information.

Contributor guide

Open the contributing guide

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 comparing the pod in Rex.pm with README.md to identify how their information differs and whether the README is currently generated. Check the repository’s existing documentation or build instructions for a generation entry point. Done means README.md is generated from Rex.pm and presents the same information as the metacpan.org pod.

Written by the indexing model from the issue text.

Assessment

Tech stack
perl
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.