Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

81 lines (51 loc) · 3.64 KB

Contributing

Thanks for checking out Opentecture. We're excited to hear and learn from you. Sharing your experiences will benefit others who read and use these guides.

The following guidelines may help you figure out where to best participate.

Table of Contents

  1. Types of contributions we're looking for
  2. Ground rules & expectations
  3. How to contribute
  4. Community

Types of contributions we're looking for

There are many ways you can contribute:

Meet others and share
Mentoring
  • provide architectural guidance
  • provide construction/market guidance
  • provide design/manufacturing/materials/supply chain/any-applicable-skill guidance
Design and develop Open 3d Components
  • Design and develop 3d parts
Provide feedback and fix things
Maker-ing
  • provide a 3d printer
  • provide a FabLab or membership
Feeling philanthropic?
  • donate BTC or cash
  • provide temporary land
  • provide permanent land
Anything else
  • Add stories, examples, or anecdotes that help illustrate a point
  • Revise language to be more approachable and friendly
  • Translate into other languages/formats

Interested in making a contribution? Read on!

Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

  • Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
  • If you open a pull request, please consider including test cases. If there are test failures, you will need to address them before we can merge your contribution.
  • When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created as others will do so if they appreciate it.

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this guide, do one of the following:

  • If your contribution is minor, such as a typo fix, open a pull request.
  • If your contribution is major, such as a new guide, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

Community

Discussions about Opentecture takes place on this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations. There is also a Slack channel for ongoing chat.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.