3drobotics / solodevguide

Solo Development Guide (SDG).
http://dev.3dr.com/
40 stars 62 forks source link

How can people contribute to the guide / edit / submit changes? #49

Open tcr3dr opened 9 years ago

tcr3dr commented 9 years ago
tcr3dr commented 9 years ago

An edit link is now added to every page. This issue now should track how we steward edits from the community / what improvements we can make to the process.

For instance, improving CONTRIBUTING.md is a goal.

tcr3dr commented 9 years ago

See http://ffc6904fed514b42b88f87926328069c5c8149f4.s3-website-us-east-1.amazonaws.com/starting-contributing.html

mrpollo commented 9 years ago

I proposed we change the name of this section to "About this guide" or similar, and we list "Contributing" as a sub-section of this, we should also add all of the sub-tasks above as sub-sections

tcr3dr commented 9 years ago

The style guide should go into CONTRIBUTING.md and include

  1. Use asides “note”, “warning”, and “danger”.
  2. Use italics for tool names. First instance of tool name page should, if possible, link to the tool "official" page or wikipedia page if that is not available.
  3. Use code style for paths
  4. Use bold for button presses
  5. Use divs for "host", "solo" code as per https://github.com/3drobotics/solodevguide/pull/143#issue-106672962
  6. Creating a branch on the repository and submitting a PR is good for controversial things. Anything typo or even blatantly wrong can just edit master directly. PRs enforced when we’re public.
hamishwillee commented 9 years ago

Hi @tcr3dr UPdated your note above to be a set of instructions. Please check these are correct as I will start confirming to them

I have fixed the runit typo, replaced all sdg instances except the one in code, and converted all the existing notifications to asides.

franknitty69 commented 8 years ago

edit buttons has been added to all the pages which allows contributors to fork, edit and issue a pr. does this cover this issue? if so, can it be closed?