onaio/tasking

Update Documentation

Open

#161 opened on Jan 20, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Python (3 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (5 stars)
PR merge metrics
 (PR metrics pending)

Description

Suggested Feature / Enhancement

Some of our documentation has not been completed. Would be nice if we documented everything currently undocumented in the codebase.

Benefits of implementing the feature / enhancement

  • Would make it easier for contributors and passerbys to understand what the package is about
  • Would give a better idea on when and where this package could be useful

Suggested implementation plan(Steps to be taken to implement feature)

None at the moment

Contributor guide

Research direction
Inspect the existing documentation and codebase to identify all undocumented modules and functions. Create a plan to write docstrings and update the README.
Tech stack
pythondjango
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75