search

spacedecentral / Coral

Coral is an open source robotic space mission, designed to perform in-situ resource utilization (ISRU) using lunar regolith as feedstock.
https://spacedecentral.net/coral
GNU General Public License v3.0
9 stars 8 forks source link

Create a task template #83

Closed Suzibianco closed 5 years ago

Suzibianco commented 5 years ago

Create a template for describing tasks, with a common structure that can be used for all tasks. Refer to this article: https://medium.com/nycplanninglabs/writing-a-proper-github-issue-97427d62a20f

founder-outbound commented 5 years ago

Initial Proposed Template

Title of Task Endeavor to be succinct but accurate with the title. Always ask yourself: "Is this a vague title, or does it give a unique and understandable description that is immediately understandable?"

Description of Task A much more in-depth accounting of what, who, and how for the task.

                   What: The Purpose of the task, the reason it exists. This can be of considerable detail to effectively explain to persons interested in the task.
                   Who: Name the principal responsible party and any other persons on the task.
                   How: Intended strategies to address any subtasks. Multiple strategies can be listed and described.

Timetable Establish an end-to-end schedule of events and milestones to accomplish the task and subtasks.

Suzibianco commented 5 years ago

@founder-outbound I'd say this is a good start. what do you think @capsulecorplab ?

capsulecorplab commented 5 years ago

LGTM

founder-outbound commented 5 years ago

I am unfamiliar with that acronym.

founder-outbound commented 5 years ago

I've tried to clean up the comment-version of the template as a Google Doc, here: https://docs.google.com/document/d/1wwmf7I_G3bfuRv5qLFvuPz9CYLj54UToJ85NThvCNVI/edit

founder-outbound commented 5 years ago

Didn't mean to close it...

capsulecorplab commented 5 years ago

LGTM = "Looks Good To Me", primarily used in the developer community to express approval or favorable feedback :slightly_smiling_face:

Engineer1119 commented 5 years ago

This looks great.

stellarmagnet commented 5 years ago

I would also add something like this (clarifying to the person completing the task the high level criteria for the work to be accepted) and how many times they can update their work if it was rejected

Acceptance Criteria

A correct submission will:

Engineer1119 commented 5 years ago

I added the content of Craig's google doc + Yalda's revision item to this document linked primarily to task #52 (creating the broader Contributing Guide). Well done!