tdd-with-java's People
Forkers
isaaaabeltdd-with-java's Issues
write a chapter about the design of the Todo-App
- Datenmodell und Datenbankdesign
- UI Design
fork repo, add contribution guide to this project and create first PR
see following example
https://github.com/philippabele/nursing-home-volunteer/blob/main/CONTRIBUTING.md
fix contextLoadTest
failed to load Application Context
code your first test in java
- create a new branch in the git repository
- code your very first basic test in java
- create a PR with code review
Include bib in main.tex
Nice list of books!
tdd-with-java/docs/bibliography.bib
Line 10 in cbf7735
I tried to find the bibliography in the compiled pdf, but unfortunately the list is not included.
https://github.com/philippabele/tdd-with-java/actions/runs/6989975329
Could you check this?
write first chapter about the idea of tdd
- create a new branch
- write your first chapter about the idea of tdd
- expand your latex documentation
- showcase the basic workflow of tdd
- explain the different types of tdd
- create a PR with code review
set up documentation
LaTeX documentation
- create a .\docs folder in your project repository
- set up the GitHub Actions for LaTeX configuration
GitHub Actions for LaTeX
To simplify the workflow for writing and reviewing the LaTeX documentation a GitHub Action is used to compile the documentation into a PDF file.
The Action is configured in .github/workflows/compile-latex.yml
.
Trigger
The trigger defines when the workflows should run and can be set with the on
. For this documentation the trigger is set to:
on:
pull_request:
branches:
- main
paths:
- 'docs/**'
With this configuration the Action is run on every PR creation/update that includes changes inside of the docs
folder and that has the target branch set to main
.
Jobs
A workflow/action contains one ore more jobs that execute the logic of the workflow/action. By default, all jobs run in parallel. For our use case we only use one job (compile
) that is defined as:
jobs:
compile:
runs-on: ubuntu-latest
env:
working_directory: docs
pdf_name: INF19B_Rickert_2858031_T3101
steps:
...
This configuration defines that the job should run on the ubuntu (linux) operating system. It also sets two environment variables that are later being used:
working_directory
: Path to the LaTeX documentation filespdf_name
: Name of the output PDF
Steps
The actual implementation of our workflow/action is defined in the steps of a job. They are e.g. bash commands that should be executed.
In order to compile the LaTeX documentation the following steps are needed:
steps:
- name: Checkout Git repository
uses: actions/checkout@v2
- name: Compile LaTeX document
uses: xu-cheng/latex-action@v2
with:
working_directory: ${{ env.working_directory }}
root_file: main.tex
- name: Rename main.pdf
run: |
mv "$working_directory/main.pdf" "$pdf_name.pdf"
- name: Upload pdf artifact
uses: actions/upload-artifact@v2
with:
name: ${{ env.pdf_name }}
path: ${{ env.pdf_name }}.pdf
if-no-files-found: error
- First this GitHub repository is checked out so that the Job has access to all
files. - Then the pre-build Action
xu-cheng/latex-action@v2
is used to compile the LaTeX code into a PDF. As parameters we pass theworking_directory
(path to the.tex
files) which in our case isdocs
and the name of the main LaTeX file which ismain.tex
- After the second step is complete a
main.pdf
will be generated which is our compiled documentation. To give it a better suited name it will be renamed the name that was defined in the jobspdf_name
environment variable - Until now the PDF only exists in the current workflow/action run so we cannot directly access it. To change this, the last step uploads the PDF file to the workflow/action run
Access the compiled PDF
To access the compiled PDF file go to the Actions
tab in GitHub and click on the desired workflow/action run. You wil see the PDF at the bottom in the Artifacts
section.
literature review
Perform a literature review with following steps:
-
Identify good sources for technical books, e.g. https://ebookcentral.proquest.com/auth/lib/mosbach-dhbw/login.action
-
Identify technical books in the context of your project.
-
Create a biblioghraphy in your LaTeX Documentation and add the found titles, e.g. https://github.com/philippabele/ball-bearings-with-quarkus/blob/main/docs/Bibliography.bib
May be there are interessting books outside of your access as a student. Feel free to ask the library staff to enrich the current collection with your title.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.