generic updates

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

@@ -3,7 +3,7 @@ name: "🐞 Issue report for package-template itself"
 about: Create a report describing unexpected or incorrect behavior.
 title: "[Issue]: <title>"
 labels: bug
-assignees: ''
+assignees: 'software-admins'
 ---
 
 <!--

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,5 +1,5 @@
 ---
-name: "Feature request"
+name: "Feature request for package-template"
 about: Suggest an idea for this project
 title: "[New Feature]: "
 labels: enhancement, needs triage

CODE_OF_CONDUCT.md

@@ -15,7 +15,7 @@ As members of the community,
 
 - We pledge to be conscientious of the perceptions of the wider community and to respond to criticism respectfully. We will strive to model behaviors that encourage productive debate and disagreement, both within our community and where we are criticized. We will treat those outside our community with the same respect as people within our community.
 
-- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting [email protected] (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
+- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting TBD (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
 
 This code of conduct applies to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
 

README.rst

@@ -16,6 +16,7 @@ To create a new package based on the template run:
    $ pip install cookiecutter cruft
    $ cruft create https://github.com/Roman-Supernova-PIT/package-template
 
+
 and go through the steps offered in the cli naming your package and filling in your details.
 Cruft is built on cookiecutter, and enables the updating of the template from the source.
 This takes the form of pull requests to the repository that the new package is pushed to.
@@ -35,6 +36,8 @@ This will create a new directory in your current directory named the same as the
 
 .. code-block:: console
 
+   $ cd <your package name>
+   $ git init
    $ pip install -e ".[docs,test]"
    $ cd docs
    $ make html

codespell-ignore.txt

@@ -0,0 +1,2 @@
+# Add words to ignore for spelling check
+# https://github.com/codespell-project/codespell

{{ cookiecutter.package_name }}/CODE_OF_CONDUCT.md

@@ -15,7 +15,7 @@ As members of the community,
 
 - We pledge to be conscientious of the perceptions of the wider community and to respond to criticism respectfully. We will strive to model behaviors that encourage productive debate and disagreement, both within our community and where we are criticized. We will treat those outside our community with the same respect as people within our community.
 
-- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting [email protected] (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
+- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting TBD (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
 
 This code of conduct applies to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
 

{{ cookiecutter.package_name }}/codespell-ignore.txt

@@ -0,0 +1,2 @@
+# add words to ignore for spelling
+# https://github.com/codespell-project/codespell