Merge pull request #244 from NLeSC/240-next-steps

Added a next steps document and updated the cookiecutter post hook

Author: jspaaks

README.md

@@ -69,6 +69,9 @@ cookiecutter https://github.com/nlesc/python-template.git
 | copyright_holder          | Netherlands eScience Center | Name(s) of the organization(s) or person(s) who hold the copyright of the software. |
 | code_of_conduct_email     | [email protected] | Email address of the person who should be contacted in case of violations of the Code of Conduct. |
 
+Once the project files have been generated, follow the steps outlined in
+[{{cookiecutter.project_name}}/next_steps.md]({{cookiecutter.project_name}}/next_steps.md).
+
 ### Step 3/3: Read about what was just generated
 
 Good job! You have now generated the skeleton for your package:

hooks/post_gen_project.py

@@ -1 +1 @@
-print("\nProject was successfully generated. For next steps, refer to file {{ cookiecutter.project_name }}/project_setup.md.\n")
+print("\nProject was successfully generated. For next steps, refer to file {{ cookiecutter.project_name }}/next_steps.md.\n")

{{cookiecutter.project_name}}/next_steps.md

@@ -0,0 +1,36 @@
+# Next steps
+
+## Put the generated files under version control
+
+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/).
+
+```shell
+cd {{ cookiecutter.project_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/{{cookiecutter.github_organization}}/repositories/new](https://github.com/{{cookiecutter.github_organization}}/repositories/new)
+and create a new repository named `{{ cookiecutter.project_name }}` as an empty repository, then push your commits to GitHub:
+
+```shell
+git push --set-upstream origin main
+```
+
+## Check automatically generated issues
+
+The first time you push to GitHub, a few issues outlining next steps will as soon as possible be added automatically
+([here]({{cookiecutter.repository}}/issues?q=author%3Aapp%2Fgithub-actions)). Resolve them to complete the setup of your
+repository.
+
+## Project layout explained
+
+For an explanation of what files are there, and what each of these do, please refer to [project_setup.md](project_setup.md).

{{cookiecutter.project_name}}/project_setup.md

@@ -7,29 +7,6 @@ text when the development of the software package takes off.
 For a quick reference on software development, we refer to [the software guide
 checklist](https://guide.esciencecenter.nl/#/best_practices/checklist).
 
-## Version control
-
-Once your Python package is created, put it under [version
-control](https://guide.esciencecenter.nl/#/best_practices/version_control)! We recommend using
-[git](http://git-scm.com/) and [github](https://github.com/).
-
-```shell
-cd {{ cookiecutter.project_name }}
-git init
-git add --all
-git commit -m "first commit"
-git branch -M main
-git remote add origin {{ cookiecutter.repository }}
-```
-
-Go to
-[https://github.com/{{cookiecutter.github_organization}}?tab=repositories](https://github.com/{{cookiecutter.github_organization}}?tab=repositories)
-and create a new repository named {{ cookiecutter.project_name }} as an empty repository, then:
-
-```shell
-git push --set-upstream origin main
-```
-
 ## Python versions
 
 This repository is set up with Python versions: