Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 7.69 KB

CONTRIBUTING.md

File metadata and controls

86 lines (61 loc) · 7.69 KB
Raw

Contributing

Thank you for your interest in helping Magrathea grow! There are lots of ways you can help. First, a quick glossary for those new to GitHub:

For more help getting started with GitHub, check out GitHub's own Learning Lab.

Generally speaking, here at Magrathea we use Discussions to brainstorm and workshop things, and Issues to keep track of actionable tasks.

The following are the general guidelines for contributing to Magrathea. Specific projects may have different guidelines, and, where this is the case, an overriding CONTRIBUTING.md document will be found in said project’s repo.

Please note that all contributions are subject to the Developer Certificate of Origin, version 1.1:

Developer Certificate of Origin Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Ways to Contribute

Report Bugs

If you've run into a problem with any Magrathea project, please let us know! We'd especially love to hear about bugs relating to accessibility or approachability. Bugs can reported as GitHub Issues. Please be sure to double check for an already existing Issue covering the same problem before opening a new one.

  • If an Issue already exists for the bug you want to report, please react to the Issue's description with a 👍. We'll regard this as a vote for more attention to be given to that bug. Please only add a new comment to the Issue if you have new information to add that is not already part of the conversation.
  • If you've found a problem with a particular project, please open an Issue in that project's GitHub repo.
  • If you've found a problem with the Magrathea site, please open an Issue in the magratheaguide.github.io repo.
  • If you'd like to fix a bug yourself, please feel free to open a PR against the corresponding repo. All PRs are reviewed for quality and consistency. While we greatly appreciate your interest in helping, please know that you may be asked to make some revisions before your PR can be merged.

Suggest an Idea

We'd love to hear about your ideas for helping Magrathea grow. Some ideas may not be right for Magrathea at the time, and we may not have the capacity to take on even the best of suggestions, but your input helps us understand and prioritize which directions to head in.

Ideas can be provided as GitHub Discussions.

  • If a Discussion has already been started for your idea, please react to the Discussion's description with a 👍. We'll regard this as a vote for more attention to be given to that idea. Please only add a new comment to the Discussion if you have new information (or a new question!) to add that is not already part of the conversation.
  • If you have a new idea for an existing project, please start a new Discussion in that project's GitHub repo.
  • If you have an idea for an entirely new project, please start a new Discussion in the magratheaguide.github.io repo.
  • If you have a new idea for the Magrathea website, please start a new Discussion in the magratheaguide.github.io repo.
  • For all other ideas, please start a new Discussion in the magratheaguide.github.io repo.
  • If you'd like to add a new feature to a project yourself, please feel free to open a PR against the corresponding repo. All PRs are reviewed for quality and consistency. While we greatly appreciate your interest in helping, please know that we may not accept every new feature or that you may be asked to make some revisions before your PR can be merged.

Ask a Question

We want to help as best we can, and that includes answering whatever questions you may have about Magrathea and its constituent projects. Please be patient if we don't get back to you right away; we'll respond when we can.

Questions can be asked as GitHub Discussions.

Members of the community are encouraged to answer questions if and only if they also provide a link to their answer's source. The goal is not to just hand folks fish, but to help teach them how to fish.

  • If a Discussion has already been started relating to your question, please react to the Discussion's description with a 👍. We'll regard this as a vote for more attention to be given to that question. Please only add a new comment to the Discussion if you have new information to add that is not already part of the conversation.
  • If you have a new question about an existing project, please start a new Discussion in that project's GitHub repo.
  • If you have a new question about the Magrathea website or its contents, please start a new Discussion in the magratheaguide.github.io repo.
  • For all other types of questions, you can start a new Discussion in the magratheaguide.github.io repo.

Send Encouragement

One of the quickest and easiest ways you can help Magrathea is to send a few words of encouragement or appreciation. You can do this via Discussions in the various Magrathea repos, or whatever other means is most comfortable for you.

Buy Us a Coffee

While we very much appreciate any interest in sending money to help support Magrathea, we do not as an organization accept funds. The best way to show your appreciation financially is to tip individual crew members. Check the Sponsor section in a repo you care about for info about tipping that project's lead, or ask a crew member directly to find out their best tipping method.