Guidelines

About the Git repository

Despite not strictly required for the course, please take care of keep your repository clean.
This involves:

• correctly setting up your .gitignore
• fill up the README.md file in a meaningful and informative way
• avoid tracking binary files, dependencies, or IDE configuration files

Finally, take care of making the last version of your code available on the master or main branches.

About Build Automation

In case your project involves the production of software artifacts, it is strongly suggested to leverage some build automation system.

There are no constraint on the particular build automation system, but keep in mind that each programming platform comes with its preferred build automation systems:

• Maven or Gradle for the Java, Kotlin, Scala
• Sbt for Scala
• NPM for JS projects
• Poetry for Python projects
• Make for C
• etc

• It is ok to develop your project in some language different from Python, but in that case it is your responsibility to select the most adequate build automation technology .

Please endow your codebase with adequate unit test suites, possibly runnable with a single command, via the build automation tool of choice.

Setting up a continous integration pipeline running the tests as frequently as possible is strongly encouraged as well.