ansys/ansys-templates

Fix README instructions

Open

#144 opened on Aug 25, 2022

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Python (4 forks)auto 404
buggood first issue

Repository metrics

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

Description

🐞 Problem As suggested by @akaszynski, the instructions in README.rst file should be improved by:

  • Removing flit installation instructions.
  • Fix command instructions indentation.

🔗 References See pull-request https://github.com/pyansys/pymechanical/pull/4 for desired final result.

Contributor guide

Research direction
Edit README.rst to remove flit installation instructions and fix command indentation as shown in PR #4.
Tech stack
python
Domain
developer experience
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90