|
1 | 1 | --- |
2 | | -title: Student Support Code Template |
| 2 | +title: Student Support Code for 'Refactoring' Task |
3 | 3 | --- |
4 | 4 |
|
5 | 5 | <!-- pandoc -s -f markdown -t markdown --columns=94 --reference-links=true README.md --> |
6 | 6 |
|
7 | 7 | ## About |
8 | 8 |
|
9 | | -This is a template repo for providing student support code (e.g. source code and tests) for |
10 | | -Java based homework assignments. |
11 | | - |
12 | | -It comes with batteries included: |
13 | | - |
14 | | -- [Gradle 8.13] preinstalled |
15 | | -- Basic Gradle configuration: |
16 | | - - [JDK 21] based projects |
17 | | - - Default [Gradle Java project layout] |
18 | | - - [JUnit 5] for software testing |
19 | | - - [Checkstyle] to check for valid Javadoc comments for all `public` elements in source |
20 | | - code |
21 | | - - [Spotless] to check formatting of Java code using the [Google Java Style Guide], can |
22 | | - also format sources if necessary |
23 | | -- [GitHub workflow] to build and test the project in [GitHub CI], check sources with |
24 | | - Checkstyle and Spotless |
25 | | -- [Dependabot] to keep dependencies (GitHub workflow, Gradle configuration) up to date |
26 | | - |
27 | | -## Usage |
28 | | - |
29 | | -This repo is intended to be used as a template repo. To create new repos for assignments, the |
30 | | -following steps may help: |
31 | | - |
32 | | -1. Fork this repo or use it as a template to create a new repo. |
33 | | -2. Add the required source code, tests and task descriptions to your new repo. |
34 | | -3. If needed, adjust the Gradle configuration to your needs. |
35 | | -4. Make your new repo available to the students. |
36 | | - |
37 | | -If desired, activate the GitHub CI in your new repo (under "*Settings \> Actions \> General \> |
38 | | -Allow actions*"). You need to allow at least the following actions: `actions/checkout@v4` and |
39 | | -`actions/setup-java@v4`. |
| 9 | +This represents the student support code for the [Refactoring task]. |
40 | 10 |
|
41 | 11 | ## License |
42 | 12 |
|
43 | 13 | This [work] by [Carsten Gips] and [contributors] is licensed under [MIT]. |
44 | 14 |
|
45 | | - [Gradle 8.13]: https://docs.gradle.org/8.13/release-notes.html |
46 | | - [JDK 21]: https://jdk.java.net/21/ |
47 | | - [Gradle Java project layout]: https://docs.gradle.org/current/userguide/java_plugin.html#sec:java_project_layout |
48 | | - [JUnit 5]: https://junit.org/junit5/ |
49 | | - [Checkstyle]: https://github.com/checkstyle/checkstyle |
50 | | - [Spotless]: https://github.com/diffplug/spotless |
51 | | - [Google Java Style Guide]: https://google.github.io/styleguide/javaguide.html |
52 | | - [GitHub workflow]: https://docs.github.com/en/get-started/using-github/github-flow |
53 | | - [GitHub CI]: https://docs.github.com/en/actions/automating-builds-and-tests/about-continuous-integration |
54 | | - [Dependabot]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot |
55 | | - [work]: https://github.com/Programmiermethoden-CampusMinden/student-support-code-template |
| 15 | + [Refactoring task]: https://github.com/Programmiermethoden-CampusMinden/Prog2-Lecture/blob/master/homework/b09.md |
| 16 | + [work]: https://github.com/Programmiermethoden-CampusMinden/prog2_ybel_refactoring |
56 | 17 | [Carsten Gips]: https://github.com/cagix |
57 | | - [contributors]: https://github.com/Programmiermethoden-CampusMinden/student-support-code-template/graphs/contributors |
| 18 | + [contributors]: https://github.com/Programmiermethoden-CampusMinden/prog2_ybel_refactoring/graphs/contributors |
58 | 19 | [MIT]: LICENSE.md |
0 commit comments