IDAES/idaes-pse

IDAES Documentation Master Issue

Open

#819 opened on Apr 21, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (314 forks)auto 404
Priority:Normaldocumentationgood first issuehelp wanted

Repository metrics

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

Description

We currently have a very large number of open issues related to documentation and examples cluttering up our release boards. To help organize things better, I am opening this as a master issue from tracking documentation related issues so that individual issues can be left of release boards unless they are being actively worked on.

Contributor guide

Research direction
Review the linked issues and pick one to work on. For example, improve code comments or add docstrings.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60