CDCgov / CDCgov/PyRenew

Review and clean up `developer_documentation.md`

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

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
29
Forks
9
Avg merge
9d 9h
Merged PRs (30d)
8

Description

See e.g.

This section should be updated with markdown examples.

Originally posted by @damonbayer in https://github.com/CDCgov/PyRenew/pull/457#discussion_r1779816417

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

Open developer_documentation.md and locate the section referenced in the quoted pull-request discussion. Review the surrounding documentation and update that section with Markdown examples, then clean up any directly related wording. Done means the requested examples are present and the file reads clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.