Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added links #101

Merged
merged 2 commits into from
Jul 1, 2024
Merged

Added links #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10c85cd
Added links
anenadic Jul 1, 2024
0f5fd5c
Update links.md
anenadic Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions episodes/06-documenting-code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -726,8 +726,9 @@ We recommend the following resources for some additional reading on the topic of
a high-quality README
- [What are best practices for research software documentation?][ssi-blog-docs] (Software Sustainability blog post) by Stephan Druskat et al.
- [Preparing Software for Reuse and Release episode][python-irsd-reuse-and-release] from the Intermediate Research Software Development lesson on The Carpentries Incubator by Aleksandra Nenadic et al.
- [How to document your research software][coderefinery-documentation] Coderefinery lesson

- [CodeRefinery lesson: How to document your research software][coderefinery-documentation]
- [CITATION.cff file format][cff]

Also check the [full reference set](learners/reference.md#litref) for the course.


Expand Down
5 changes: 3 additions & 2 deletions links.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ any links that you are not going to use.
[codecheck]: https://codecheck.org.uk/project/
[python-201-documentation]: https://python-tutorial.dev/201/tutorial/documentation.html
[python-irsd-reuse-and-release]: https://carpentries-incubator.github.io/python-intermediate-development/42-software-reuse/index.html
[coderefinery-documenting]:https://coderefinery.github.io/documentation/
[coderefinery-documentation]:https://coderefinery.github.io/documentation/
[grch-documenting]: https://goodresearch.dev/docs
[art-of-readme]: https://github.com/hackergrrl/art-of-readme#bonus-the-readme-checklist
[realpython-mkdocs]: https://realpython.com/python-project-documentation-with-mkdocs/
Expand Down Expand Up @@ -97,4 +97,5 @@ any links that you are not going to use.
[codegen]: https://www.codegen.com/
[ai-pair-programmers]: https://www.codium.ai/glossary/pair-programming/#:~:text=Ethics%20in%20AI%20Pair%20Programming
[ethics-ucl]: https://www.ucl.ac.uk/research-ethics/sites/research_ethics/files/research_using_apps_guidance_1.2.docx
[ethics-software]: https://medium.com/@zoyajahidshaikh/ethical-considerations-in-software-development-e1e4ebad2670
[ethics-software]: https://medium.com/@zoyajahidshaikh/ethical-considerations-in-software-development-e1e4ebad2670
[cff]: https://citation-file-format.github.io/
Loading