next_steps.md

Next steps

Put the generated files under version control

Once your Python package is created, put it under version control using git and GitHub.

Note that the next step assumes you have setup your connection to GitHub via SSH, see Connecting to GitHub with SSH.

Alternatively, you can also use a personal access token, see Creating a personal access token. If you choose this option, below you will have to replace git@github.com: by https://github.com/.

cd {{ cookiecutter.directory_name }}
git init
git add --all
git commit -m "first commit"
git branch -M main
git remote add origin {{ cookiecutter.repository }}

Push the initial commit to a new repo on GitHub

Go to https://github.com/organizations/{{cookiecutter.github_organization}}/repositories/new and create a new repository named {{ cookiecutter.directory_name }} as an empty repository, then push your commits to GitHub:

git push --set-upstream origin main

Check automatically generated issues

A short while after you push your commits to GitHub for the first time, a few issues outlining next steps will added automatically (here). Resolve them to complete the setup of your repository.

Project development documentation

The README.dev.md contains developer documentation.

Project layout explained

For an explanation of what files are there, and what each of these do, please refer to project_setup.md.