CONTRIB.md

How to contribute?

• Check the different ways in you can help 👇
• Join the chat
• Give us your username in github to add you to the organization

Help in Development

Technology stack: GraphQL, Apollo, Vuejs, Gridsome

Are you experienced with this technology stack? Do know people experienced with this stack?

• Designer(s) with frontend backend experience
• Backend developer(s) with expertise in GraphQL and apollo
• Frontend developer(s) experienced with Vuejs and apollo
• Lead engineers and developers currently working on initiatives that provide minimum structure of equipment documentation
• People that want to help out with translation and documentation

Find designs that have been used and operating

• Open an issue and point to the source

Document hardware designs and source files using this structure:

Can you help out with technical documentation? Here are several things you can do.

• Find one of the models online (here are some examples)
• Open an issue mentioning that you are documenting a specific model
• Make a repo and structure it considering the following folders:
  • content/docs folder subfolder for documentation. (Here we can make guides, usage etc.) This can help us later on to present the content in a nice documentation website.
  • src/ folder for source files, stls, etc
  • Make a simple readme to give context
• List the project under the github organization
  • Provide your repo in the chat

Make replication guides of the hardware above

Make translations of the guides

Share with people that can do the above if you can't or don't have time

Is there anything else we are missing?