JuliaDynamics / JuliaDynamics/ConcurrentSim.jl
refresh the examples folder: clean up, rewrite, test, and add to CI
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Julia
- Stars
- 198
- Forks
- 40
- Avg merge
- 21h 40m
- Merged PRs (30d)
- 2
Description
The examples folder has a few notebooks, but they are not part of the tests and not clearly documented. Consider rewriting them as part of the docs.
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
Start by inspecting the examples folder and the existing documentation, test suite, and CI configuration to understand how notebooks are currently handled. Determine which examples need cleanup or rewriting and how they should be documented and tested. Done means the examples are clearly documented, covered by tests, and included in CI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- ci-cd, documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100