Add beginner documentation #397
Conversation
|
This is still in draft mode but I already welcome test readers to share their feedback to avoid large rewrites further down the road. |
6e2cf8f to
809787a
Compare
There was a problem hiding this comment.
This is a fantastic walkthrough @martin-schulze-vireso, really clear writing and first-time journey 🎉
9c52790 to
98f3e78
Compare
|
@martin-schulze-vireso Thanks so much for doing the research and work into typing this up! |
| Make sure to also read the list of gotchas and the faq. | ||
|
|
||
| For this tutorial we are assuming you already have a project in a git repository and want to add tests. | ||
| Ultimately they should run in the CI environment but will also be started locally during development. |
There was a problem hiding this comment.
Ultimately they should run in the CI environment but will also be started locally during development.
This is a subjective thing - I believe that particular sentence is a bit out of place since the writing of the tests will be the same process whether or not it runs locally or in CI. Maybe we can add a separate TODO section for "Example of bats in CI"?
There was a problem hiding this comment.
What I meant to express here is: Most editing/test development won't be done on the CI system. But automated tests are mainly intended to be run in a CI environment.
Of course, there are other workflows but in my view there are two main usecases:
- unsupervised batch execution, e.g. on the CI server
- interactive execution, e.g. on the developer machine
Obviously, there is are cases in between, like git bisect run.
0cad67a to
85ac796
Compare
85ac796 to
c094e68
Compare
|
This is an awesome job to ship so much good, clear documentation @martin-schulze-vireso 🎉 |
Closes #358
The resulting output can be previewed here.
The companion repository for the example project can be found here: https://github.com/martin-schulze-vireso/bats-tutorial
fix all remaining todos in the text
I have reviewed the Contributor Guidelines.
I have reviewed the Code of Conduct and agree to abide by it