theforeman/foreman-documentation

Rephrase comments in example Python/Ruby/Shell scripts

Open

#3,379 opened on Oct 17, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)SCSS (113 forks)auto 404
good first issue

Repository metrics

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

Description

          The comments could indeed use some love :) if you have the time

Originally posted by @Lennonka in https://github.com/theforeman/foreman-documentation/pull/3353#discussion_r1799986995

Contributor guide

Research direction
Find the example scripts mentioned in the repository and rephrase their comments to be clearer and more helpful.
Tech stack
pythonrubyshell
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.
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90