diff --git a/.github/ISSUE_TEMPLATE/1_Getting_Started.md b/.github/ISSUE_TEMPLATE/1_Getting_Started.md new file mode 100644 index 0000000000000000000000000000000000000000..c15b1d44bfc06b28821cf54d0bcc5e88eba77a26 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_Getting_Started.md @@ -0,0 +1,15 @@ +--- +name: Getting Started +about: Request Documentation for Getting Started +labels: [getting-started] +--- + +**Documentation Topic** +<!-- The overarching topic of the requested documentation. --> + +**Lessons-To-Be-Learned** +<!-- A list of the lessons that users can learn by following the requested documentation. --> + +**Illustrative Task** +<!-- The task that will be used to teach the lessons-to-be-learned. --> + diff --git a/.github/ISSUE_TEMPLATE/2_How_To.md b/.github/ISSUE_TEMPLATE/2_How_To.md new file mode 100644 index 0000000000000000000000000000000000000000..6c8cb6a38a499506fce6585701186564bf5864fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_How_To.md @@ -0,0 +1,11 @@ +--- +name: How-To +about: Request a How-To Guide +labels: [how-to] +--- + +**Documentation Topic** +<!-- The overarching topic of the requested documentation. --> + +**Description of Task** +<!-- A basic description of the task that should be documented. --> \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3_Concept.md b/.github/ISSUE_TEMPLATE/3_Concept.md new file mode 100644 index 0000000000000000000000000000000000000000..50b8e6dbf1afc5a117ab45fc2c0a07f4e3728c8d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_Concept.md @@ -0,0 +1,17 @@ +--- +name: Concepts +about: Request a Concept Document +labels: [concepts] +--- + +**Documentation Topic** +<!-- The overarching topic of the requested documentation. --> + +**Working Title** +<!-- A working title for the documentation page. --> + +**Documentation Scope** +<!-- A description of the topics and concepts that should be described in the document. --> + +**(Optional) Sources** +<!-- Sources from which information was gathered. --> diff --git a/.github/ISSUE_TEMPLATE/4_Manual.md b/.github/ISSUE_TEMPLATE/4_Manual.md new file mode 100644 index 0000000000000000000000000000000000000000..4e38cae6de6b6b0970456d1bb2f207f7ac920e85 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_Manual.md @@ -0,0 +1,26 @@ +--- +name: Manual +about: Request a Software Manual +labels: [manual] +--- + +**Documentation Topic** +<!-- The overarching topic of the requested documentation. --> + +**Description of Software** +<!-- An overview of the software. --> + +**Relationship To ASC** +<!-- How does this software relate to the Astrogeology Science Center's software portfolio? --> + +**Documentation Maintainer** +<!-- The envisioned maintainer of the software manual. --> + +**Maintenance Process** +<!-- A description of the library's maintenance process and a link to the homepage to which updates are pushed. --> + +**Link to Existing Documentation** +<!-- A link to the library's existing documentation. --> + +**Link to Software Repository** +<!-- A link to the library's repository of record. --> \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df36b1ed580691fc921a3325afdd8605bf7277d6..4d198ec32af94eaf57a8fdca3e32aa93c363098a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,9 +37,17 @@ Before submitting a bug report, please follow the checklist to help us address t - Attach your input and output, if feasible. - Attach the stack trace. - Make note of your OS, Platform and Version. - - Make not of your environment configs (compiler, package manager, conda env dependencies) + - Make note of your environment configs (compiler, package manager, conda env dependencies) - Verify that the bug is reproducible. +## Requesting Documentation + +When requesting new documentation, the author of the issue should specify both the topic and category of the desired documentation. The documentation category must be "Getting Started," "How-To," "Concept," or "Manual," and the specific requirements for posting the issue will be determined by the documentation category. Each of the documentation categories has an associated issue template that will guide the requester through the following category-specific requirements: + - Getting Started: a lesson or list of lessons to be learned (e.g. how does map projection with CSM work in ISIS) and an associated task by which those lessons will be conveyed (e.g. create a map-projected image using CSM). + - How-To: a definition of the basic problem that needs to be solved (e.g. how to append to the CSM search directories) + - Concept: a pending title, the scope of the proposed documentation, and a list of any sources from which information should be included + - Manual: a description of the software, its relationship to the Astrogeology Science Center, and who will maintain the software manual as the library matures. Additionally, the requester should describe how the software is currently maintained as well as providing information related to the location to which updates are regularly pushed. Finally, the requester should include a link to existing documentation for the library. + # Contributions Any change to resources in this repository must be through pull requests. This applies to all changes