Simulation-Software-Engineering / Simulation-Software-Engineering/Lecture-Material
Suggestion for Per Chapter Readme
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 63
- Forks
- 70
- Avg merge
- 8d 18h
- Merged PRs (30d)
- 1
Description
Currently the content in per chapter Readme is not in a flow.
Example:
It would be nice to make it in a better flow like:
I would be happy to create a PR for it. Thanks.
gitlab id: dardama
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the per-chapter README files and compare their current content order with the two example images in the issue. Done means the affected READMEs follow a clearer, consistent flow and the rendered content matches the intended arrangement.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100