Fine-grained history and citation guidelines for each tutorial
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 142
- Forks
- 167
- Avg merge
- 20h 24m
- Merged PRs (30d)
- 11
Description
We currently tell people to cite the preCICE Distribution (data publication), but sometimes we also want to cite an academic publication for a specific test case. This information is kind of lost at the moment.
Suggestion:
- Add a "History and citing" section at the bottom of some tutorials
- Add a note for tutorials in the literature guide
- Later, add a "History and citing" to every tutorial
The history and citing section should include information also about solver-specific cases.
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 with the preCICE Distribution page and the literature guide linked in the issue, then review the tutorials to identify solver-specific test cases and their existing citation information. Done means selected tutorials have a "History and citing" section and the literature guide points readers to those sections, with later expansion to every tutorial tracked separately.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100