diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py index 1b8b598b..889268ff 100644 --- a/hooks/pre_gen_project.py +++ b/hooks/pre_gen_project.py @@ -5,6 +5,6 @@ "package_name": cookiecutter.package_name.lower().replace(" ", "_").replace("-", "_"), "directory_name": cookiecutter.directory_name.lower().replace(" ", "-"), "full_name": cookiecutter.full_name.replace('\"', '\\\"'), - "repository": "https://github.com/" + cookiecutter.github_organization + "/" + cookiecutter.directory_name.lower().replace(" ", "-"), + "repository": "git@github.com:" + cookiecutter.github_organization + "/" + cookiecutter.directory_name.lower().replace(" ", "-"), "package_short_description": cookiecutter.package_short_description.replace('\"', '\\\"') }) }} diff --git a/{{cookiecutter.directory_name}}/next_steps.md b/{{cookiecutter.directory_name}}/next_steps.md index 4858fbbe..253814d7 100644 --- a/{{cookiecutter.directory_name}}/next_steps.md +++ b/{{cookiecutter.directory_name}}/next_steps.md @@ -6,6 +6,13 @@ Once your Python package is created, put it under [version control](https://guide.esciencecenter.nl/#/best_practices/version_control) using [git](https://git-scm.com/) and [GitHub](https://github.com/). +Note that the next step assumes you have setup your connection to GitHub via SSH, +see [Connecting to GitHub with SSH](https://docs.github.com/en/github-ae@latest/authentication/connecting-to-github-with-ssh). + +Alternatively, you can also use a personal access token, see +[Creating a personal access token](https://docs.github.com/en/github-ae@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). If you choose this option, below you will have to replace +`git@github.com:` by `https://github.com/`. + ```shell cd {{ cookiecutter.directory_name }} git init