Skip to content

Commit

Permalink
tweaks + move resoureces to own file
Browse files Browse the repository at this point in the history
  • Loading branch information
alessandrofelder committed Oct 9, 2023
1 parent f63d57b commit 5033fbf
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 35 deletions.
35 changes: 1 addition & 34 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://unsplash.com/@mparzuchowski?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">Michał Parzuchowski</a> on <a href="https://unsplash.com/photos/yqD-v4fidt0?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">Unsplash</a>](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/)
{{< include slides/resources.qmd >}}
6 changes: 6 additions & 0 deletions slides/refactoring.qmd
Original file line number Diff line number Diff line change
@@ -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
40 changes: 40 additions & 0 deletions slides/resources.qmd
Original file line number Diff line number Diff line change
@@ -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/)
2 changes: 1 addition & 1 deletion slides/testing.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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...?
Expand Down

0 comments on commit 5033fbf

Please sign in to comment.