Create Contributing.md - Githubissues

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 Contributing.md #52

Open stellarmagnet opened 6 years ago

stellarmagnet commented 6 years ago

[ ] Create an instructional file in the root directory (Contributing Guide). Perhaps we have a "beginner" version that does detailed step by step for creating a pull request.

Suzibianco commented 6 years ago

@capsulecorplab are you creating this Contributing Guide?

Engineer1119 commented 5 years ago

Current draft here https://docs.google.com/document/d/1wbTkeQEVOcC9sX_MwdGwdWCxvkcP7yS5kQI6c3oOWDY/edit

Engineer1119 commented 5 years ago

Admittedly the GOVERNANCE.md task isn't 100% blocked by this task, but I marked it as a dependent to this task in observance that NodeJS' equivalent governance document references contributing.md and getting-started.md as sister documents that, if not fully and separately defined, can have overlapping scope with a governance document.

I'm open to being convinced that the dependency shouldn't be stated; as an alternative how about placing the 3 (governance, contributing, getting-started) in an epic?

Engineer1119 commented 5 years ago

per Sean: in the future, also include a guide for uploading documents stored in the repo, including a style guide. See other examples of Contributing.md via google searches