Skip to content
Snippets Groups Projects
Unverified Commit 07a448d7 authored by Austin Sanders's avatar Austin Sanders Committed by GitHub
Browse files

Edited contributing docs and issue templates (#49)

* Added guidelines and issue templates for contributions

* Edited wording of documentation topic tag

* Added missing example

* Fixed typo

* Added fields for sources and repo link
parent 6a359aa7
No related branches found
No related tags found
No related merge requests found
---
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. -->
---
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
---
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. -->
---
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
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment