From 5033fbf615c57dbed3cc5f81fc57561554902af8 Mon Sep 17 00:00:00 2001 From: alessandrofelder Date: Mon, 9 Oct 2023 13:25:18 +0100 Subject: [PATCH] tweaks + move resoureces to own file --- index.qmd | 35 +---------------------------------- slides/refactoring.qmd | 6 ++++++ slides/resources.qmd | 40 ++++++++++++++++++++++++++++++++++++++++ slides/testing.qmd | 2 +- 4 files changed, 48 insertions(+), 35 deletions(-) create mode 100644 slides/resources.qmd diff --git a/index.qmd b/index.qmd index 46a3400..ed38e23 100644 --- a/index.qmd +++ b/index.qmd @@ -172,38 +172,5 @@ pip install my_awesome_package * evaluating and improving the quality of code 🤔 (code smells, refactoring, DRY) * creating a python package 📦 (cookiecutter, pypi) -## Documentation resources -## Testing resources - -* [Pytest docs](https://docs.pytest.org/en/7.3.x/) - -## Code review and issue tracking resources -:::: {.columns} - -::: {.column width="50%" style="font-size: 0.5em;"} -![Photo by Michał Parzuchowski on Unsplash](img/michal-parzuchowski-yqD-v4fidt0-unsplash.jpg){height=400} -::: - -::: {.column width="50%"} -* [Step-by-step guide](https://blog.ossph.org/a-beginners-guide-to-contributing-to-open-source-projects/) -* Advice on how to do code review: - * as [an author](https://mtlynch.io/code-review-love/) - * as [a reviewer](https://mtlynch.io/human-code-reviews-1/) -* The Zeigarnik effect: Why creating issues [helps you switch off](https://todoist.com/inspiration/zeigarnik-effect-comic) -::: -:::: - -## RSE Community - -* join the community! - * [SWC slack `#software-skills`](swc-neuro.slack.com) - * [UCL Research Programming Hub](https://www.ucl.ac.uk/advanced-research-computing/community/ucl-research-programming-hub) - * [Research Software London](https://rslondon.ac.uk/) - * [Research Software Engineering societies](https://society-rse.org/international-rse-organisations/) - -### More context about Research Software Engineering - -* [The four pillare of RSE](https://ieeexplore.ieee.org/document/8994167) -* [The Software Sustainability Institute](https://www.software.ac.uk/) -* [The hidden REF – Celebrating all research outputs](https://hidden-ref.org/) \ No newline at end of file +{{< include slides/resources.qmd >}} \ No newline at end of file diff --git a/slides/refactoring.qmd b/slides/refactoring.qmd index bf6750d..6ff71e1 100644 --- a/slides/refactoring.qmd +++ b/slides/refactoring.qmd @@ -1 +1,7 @@ # Code Quality + +## Code smells + +> A code smell is a surface indication that usually corresponds to a deeper problem in the system. + +- Martin Fowler \ No newline at end of file diff --git a/slides/resources.qmd b/slides/resources.qmd new file mode 100644 index 0000000..9893c8d --- /dev/null +++ b/slides/resources.qmd @@ -0,0 +1,40 @@ +# Resources + +## Documentation resources + +## Testing resources + +* [Pytest docs](https://docs.pytest.org/en/7.3.x/) + +## Refactoring resources + +* [31 code smells](https://pragmaticways.com/31-code-smells-you-must-know/) + + +## Packaging resources + +* [NIU cookiecutter](https://github.com/neuroinformatics-unit/python-cookiecutter) +* [Python packaging tutorial](https://packaging.python.org/en/latest/tutorials/packaging-projects/) +* [Python wheels walkthrough](https://youtu.be/FpIJ7T1Gpjo?feature=shared&t=1638) + +## Code review and issue tracking resources + +* [Step-by-step guide](https://blog.ossph.org/a-beginners-guide-to-contributing-to-open-source-projects/) +* Advice on how to do code review: + * as [an author](https://mtlynch.io/code-review-love/) + * as [a reviewer](https://mtlynch.io/human-code-reviews-1/) +* The Zeigarnik effect: Why creating issues [helps you switch off](https://todoist.com/inspiration/zeigarnik-effect-comic) + +## RSE Community + +* join the community! + * [SWC slack `#software-skills`](swc-neuro.slack.com) + * [UCL Research Programming Hub](https://www.ucl.ac.uk/advanced-research-computing/community/ucl-research-programming-hub) + * [Research Software London](https://rslondon.ac.uk/) + * [Research Software Engineering societies](https://society-rse.org/international-rse-organisations/) + +### More context about Research Software Engineering + +* [The four pillare of RSE](https://ieeexplore.ieee.org/document/8994167) +* [The Software Sustainability Institute](https://www.software.ac.uk/) +* [The hidden REF – Celebrating all research outputs](https://hidden-ref.org/) \ No newline at end of file diff --git a/slides/testing.qmd b/slides/testing.qmd index d866362..646c6d4 100644 --- a/slides/testing.qmd +++ b/slides/testing.qmd @@ -84,7 +84,7 @@ Try to cover all "edge" cases[^2]: what happens if ...? [^2]: [A Beginner’s Guide to Testing: Error Handling Edge Cases](https://www.freecodecamp.org/news/a-beginners-guide-to-testing-implement-these-quick-checks-to-test-your-code-d50027ad5eed/) -## How to think about what to test +## How to think about what to test {.smaller} What we've called sanity checks are referred to as "test cases". For example, what happens/should happen when you call...?