Adding the project to GitHub

The generated {repo_name} directory should be an initialised git repository. We now need to connect it to GitHub:

  1. Create a new repository on GitHub . Do not initialize the repo with a README, license, or any other files.

  2. Push the local repository to GitHub. The GitHub documentation should provide instructions for doing so, but in short:

    • Add the remote named origin with git remote add origin <URL>

    • Push the local repository to the remote repository with git push -u origin main

    • Verify files were pushed successfully by checking on GitHub

GitHub features

The .github/ directory contains configuration files for useful features in GitHub, including:

  • workflows/gh-ci.yaml for running Continuous Integration using GitHub Actions. Other GitHub actions, e.g. for deployments, can be added to the workflows/ directory.

  • .github/ISSUE_TEMPLATE/ and .github/PULL_REQUEST_TEMPLATE.md provide templates that will be presented by GitHub to community members when making Issues and Pull Requests on your project’s repository. They will help guide users/contributors to include all the relevant information, simplifying the process for both you and them.