CDCgov / CDCgov/PyRenew

Finish "Additional Developer Info" section of developer documentation

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

Nobody has claimed this yet.

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

Description

Additional Developer Info
-------------------------

-  makefile
-  numpydocs
-  How does typos work?
-  download artifact for website preview
-  How to create a new tutorial
-  How to add documentation for a new module to the website

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 locating the developer documentation section containing “Additional Developer Info.” Review the six listed topics—makefile, numpydocs, typos, website-preview artifacts, tutorials, and new-module documentation—and determine the expected content for each. Done means the section provides complete guidance for all listed topics.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.