CONTRIBUTING.md

Contribution Guide

• Contribution Guide
  • Recommendations
  • What is the structure of the robotics knowledgebase?
    • How to add a project
    • What are the differences between the types of resources?
  • How to add articles, books, and websites

Recommendations

• Always spell out abbreviations when used for the first time on a page.
• Use underscore for spaces in filenames.
• When in doubt, just contribute and don't worry about formatting.

What is the structure of the robotics knowledgebase?

How to add a project

• Look for an existing project that matches what you're doing, if one exists add your code/findings to the existing project.
• If no project exists, create a new one with a README.md file describing the project and linking to further documentation/code examples in the same folder.

What are the differences between the types of resources?

• A website is a page of an online resource, e.g. https://bellinghammakerspace.org
• An article is a post with content on a specific topic, e.g. https://bellinghammakerspace.org/posts/makercraft-launched/
• A book is a book, often acquirable in physical form. e.g. Tautology for dummies
• An online community is often a subpage of a website, such as https://reddit.com/r/bellingham, or a communication group like Discord, Slack, etc.
• Other is any resource that does not neatly fit under one of the other resource types.

How to add articles, books, and websites

Book Format:

• Title
• Author
• ISBN-13
• Official Link (Goodreads?)
• Purchase Link (Amazon Smile)
• Description/Book summary (100 words)
• Commentary/why to read (100 words)

Article Format

• Title
• Author
• Official Link
• Description (100 words)
• Commentary (100 words)