Skip to content

Commit

Permalink
Update readme and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hnformentin authored Sep 13, 2023
1 parent 5397063 commit 1802ab2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 41 deletions.
44 changes: 6 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Disclaimer
Sharing is caring! This is part of a learning journey. We are much more curious individuals than experts. The objective is to share our learnings so far while enabling us to collaborate, learn and connect around an important topic. We assume that independently of your experience, you are curious to learn, courageous to ask and share and, finally, respectful about the stage each one is in right now.

The workshop is based on our own work together.
You will find imperfections or questionable things, let's discuss them.

Commit early and often!
Good practices for a commit, by [Chris Beams](https://chris.beams.io/posts/git-commit/)

# Purpose
Dive into tests and Test-Driven-Development (TDD) by sharing experience and practicing together
- Practical workshop, mainly with examples
Expand All @@ -26,24 +32,6 @@ functions by looking at your tests
# Requirements
Please check the [dedicated page for this workshop](/docs/workshop-pre-reqs.md).

# Story
Disclaimer: the workshop is based on our own work together.
You will find imperfections or questionable things, let's discuss them.

We will go through:
1. Check that all requirements are in place for all
2. Share previous experiences with TDD
3. Demonstrate TDD while working together (~peer-programming)
4. Present a problem to solve
5. After each step, a pause for:
- sharing the work
- discussing key topics/challenges
- catching up
6. Conclude with wrap-up and feedback

Commit early and often!
Good practices for a commit, by [Chris Beams](https://chris.beams.io/posts/git-commit/)

# One way to go
0. Make a list of tests we know we need to have working
1. Add a little test: write just enough of a test to fail
Expand All @@ -61,23 +49,3 @@ Discussions:
- DRY: Don't Repeat Yourself!
- @pytest.mark.parametrize to run multiple test cases
- Debugging with test (tools?)

# Contributing

## Run tests
[pytest](https://docs.pytest.org/en/latest/) is used as the test runner, to test:

```sh
# Test
pytest
```

this requires that the dev dependencies from `dev-requirements.txt` are installed.

```sh
# Install test requirements
pip install -r dev-requirements.txt
```

# References
The exercise presented on the issues are based on: https://kata-log.rocks/string-calculator-kata
3 changes: 0 additions & 3 deletions docs/workshop-pre-reqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,4 @@ Some knowledge to basic python, git, Linux commands will be helpful.

Make sure that your microphone and camera is working properly. This is an interactive workshop. In addition to knowledge transfer, the course is very much focused on discussion, team building and learning from each other. We expect all participants to engage and contribute, and we will ask everyone attending to keep their camera on during the whole course.




This section used https://github.com/equinor/oc-iaas-iac-course as reference.

0 comments on commit 1802ab2

Please sign in to comment.