Home

How to use this template repository

1. [If you are a DT Employee] Get in touch with the Deutsche Telekom OSPO to start the workflow to get a repository for your project.
2. Clone your repository, it will contain the files of this repository.
3. Update the title of the README.md to your project's title.
4. Update the "About" section of the README.md to describe your project and add installation, deployment information and documentation.
5. In the GitHub Web Interface, on the right side, update the "About" to describe your project.
6. Run pipx run reuse init (See https://github.com/telekom/reuse-template#reuse for more info on REUSE) and provide the requested information.
7. Add your code.
8. Run pipx reuse annotate ... (See https://github.com/telekom/reuse-template#reuse for an example) to add Copyright and license statements to all files.
   • For the inital run pipx run reuse annotate -c "Deutsche Telekom AG" -l "<SPDX-LICENSE-ID>" --recursive --skip-existing ./ might be a good choice.
   • BEWARE: Replace the with the appropriate real license ID (see https://spdx.org/licenses/ for options), in most cases that will be Apache-2.0.
   • BEWARE: Use the right path! If your assets are under a different license than your code, you might want to do one run on ./src and one on e.g. ./resources.
     • For non-code assets a useful license is CC-BY-4.0
9. Run pipx run reuse download --all to make sure license text is placed in the ./LICENSES/ directory.
10. Run pipx run reuse lint to verify the project is REUSE compliant.

How to keep the repository compliant

1. By default the reuse compliance check GitHub action runs on each push and PR to tell you the status. Feel free to modify this to your needs, but the main branch should always stay compliant.
2. When adding new files pipx reuse annotate ... needs to be run on the files to add the copyright and license.
   • e.g. pipx run reuse annotate -c "Deutsche Telekom AG" -l "Apache-2.0" <mynewfile> will add copyright for DT AG for the current year and set the license to Apache 2.0.
3. Despite the GitHub action it is good practice to run pipx run reuse lint before committing new files to verify none are missing licensing information.
   • You can use a pre-commit hook to automate this: https://reuse.software/dev/#pre-commit-hook.
4. Note: It is not necessary to update the copyright year in files, however it is recommended to do so if major changes were made since the last year shown in the copyright line.
   • You can either simply run pipx run reuse annotate -c "<copyright holder>" -l "<license>" <myfile> again, which will add a new copyright line for the new year.
   • or manually change e.g. "2021" to "2021-2023" in the existing line.