Test how docassemble github integration works.

Author: vanlankveldthijs

.gitignore

@@ -0,0 +1,41 @@
+__pycache__/
+*.py[cod]
+*$py.class
+.mypy_cache/
+.dmypy.json
+dmypy.json
+*.egg-info/
+.installed.cfg
+*.egg
+.vscode
+*~
+.#*
+en
+.history/
+.idea
+.dir-locals.el
+.flake8
+*.swp
+.DS_Store
+.envrc
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/

LICENSE

@@ -0,0 +1 @@
+Apache-2.0

MANIFEST.in

@@ -0,0 +1 @@
+include README.md

README.md

@@ -0,0 +1,3 @@
+# Software Management Plan
+
+This is a questionnaire package for a Software Management Plan (SMP). It is used with the `docassemble` framework: https://docassemble.org .

docassemble/SMPDecisionTree/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.0.4'

docassemble/SMPDecisionTree/data/questions/documentation.yml

@@ -0,0 +1,41 @@
+---
+mandatory: public or reuse
+question: |
+  Documentation
+
+fields:
+  - note: |
+      **User Documentation**
+
+      How will `${ software_name }` be documented for users?
+
+      Please provide a link to the documentation, if available. How will you document your software’s contribution guidelines and governance structure? If you have any (additional) plans on how your software will be documented (e.g. creating tutorials, incorporating it in teaching, etc.) please specify.
+  - no label: user_documentation
+    hint: The documentation is part of the repository and will be generated with each release. An automated process publishes each version at https://sky-scanner.readthedocs.com
+    input type: area
+    rows: 10
+  - note: |
+      **Developer Documentation**
+
+      How will `${ software_name }` be documented for future developers?
+
+      Please explain how the software can be modified (docstrings, in-line comments, etc.), tested, and contributed to (governance, code of conduct, contributing guidelines, etc.).
+    show if:
+      code: reuse
+  - no label: developer_documentation
+    hint: The developer documentation is part of the repository. It is a file called `README.dev.md`.
+    input type: area
+    rows: 10
+    show if:
+      code: reuse
+  - note: |
+      **Deployment Documentation**
+
+      How will the installation requirements, deployment- and testing instructions of `${ software_name }` be documented?
+
+      Please provide a link to the installation documentation if available. This documentation should include a complete and unambiguous description of dependencies to other software, datasets, and hardware.
+  - no label: deployment_documentation
+    hint: The deployment documentation is a living document which is versioned with the software. It can be found at https://docs.google.com/heartbleed_deploy_doc
+    input type: area
+    rows: 10
+---

docassemble/SMPDecisionTree/data/questions/name_purpose.yml

@@ -0,0 +1,24 @@
+---
+mandatory: True
+question: |
+  Software Name & Purpose
+fields:
+  - note: |
+      What is the name of your software or framework?
+  - no label: software_name
+    hint: my_software
+  - note: |
+      Please provide a brief description of your software or framework, stating its purpose and intended user community, if any.
+
+      Clearly state the purpose of the software. Provide general information such as: what problem does it solve, who is the intended audience, what are its advantages and limitations, etc. A clear explanation of the purpose of the software helps the developer focus on its specific needs.
+
+      Some aspects to be considered:
+
+      - What is the purpose of the software?
+      - What is the software’s intended user community?
+      - Why are you developing this and not reusing existing software?
+  - no label: purpose
+    hint: This BASH script proves the Hauptvermutung conjecture and generates some visual examples. It is intended to be used by the general math community. We are developing this software because no prior software like this exists since no one else proved the Hauptvermutung.
+    input type: area
+    rows: 10
+---