JuliaDynamics / JuliaDynamics/NonlinearDynamicsTextbook
Reference possibility of stating problems/issues with book on GitHub
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 266
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
In chapter 1 we cite the GitHub repository of the book. Part of this repository is the very nice ability to have open discussion on potential things that are incorrect in the book (such as typos), or sections that may be better explained or missing. So, in the book we should actively motivate readers to contribute/open issues on this GitHub page!
(we only cite the GitHub page, but we don't present it with its full potential)
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
Review chapter 1 and the existing GitHub repository reference to find where its contribution options are introduced. Update that passage to encourage readers to report typos, incorrect content, unclear explanations, or missing sections through GitHub issues; done means the book explains this use of the repository explicitly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100