index.md

title: "Guides for Software Engineering Students" pageNav: 2

{% from 'scripts/macros.njk' import thumbnail with context %}

This website contains a collection of tutorials, standards, guides, best practices etc. useful for SE students.

{{ thumbnail(":fas-chalkboard-teacher:") }} Tutorials

Tutorials, how-to guides, getting-started guides, ...

• AddressBook Level-3 (AB3)
• Checkstyle
• Codecov
• Java:
  • Installation
    • :fab-apple: Mac
    • :fab-windows: Windows
    • :fab-linux: Linux
  • JAR files
  • JavaFX:
    • Part 1: Getting started
    • Part 2: Creating a GUI for Duke
    • Part 3: Interacting with the user
    • Part 4: Using FXML
    • Part 5: Tweaking the GUI
• Intellij IDEA:
  • Configuring the JDK
  • Importing a Gradle project
  • Configuring the code style
  • Using the debugger
  • Useful settings
• Visual Studio Code
• Sourcetree
• Testing
  • Automated testing of text UIs
  • JUnit
• GitHub Actions
• Gradle
• Project documentation:
  • Jekyll
  • MarkBind
    • Working with forked MarkBind sites
  • Netlify
  • PlantUML
  • Saving web documents as PDF files

{{ thumbnail(":fas-file-code:") }} Conventions

Coding standards, format conventions, style guides, ...

• C# coding standard
• CSS coding standard
• Files/Folders naming
• Git conventions
• GitHub conventions
• HTML coding standard
• Java
  • coding standards: basic | basic + intermediate | all
  • logging conventions
• JavaScript coding standard
• Markdown coding standard

{{ thumbnail(":fas-map-signs:") }} Guidelines

Best practices, processes, workflows, ...

• Code of conduct
  
• Working with Git
• GitHub:
  • Working with PRs
    • Best practices for reviewing PRs
  • Working with labels