Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

66 lines (49 loc) · 3.2 KB

Request for Contributions

Please contribute to this repository if any of the following is true:

  • You have knowledge in Golang, GitHub Actions, coding processes and best practices, graphic design, or development
  • You have expertise in community development, communication, or education
  • You want open source communities to be more collaborative and inclusive
  • You want to help lower the burden to first time contributors
  • You are a first time contributor or are learning to code (we welcome all contributions)

How to Contribute

Prerequisites:

Note: If you do not have familiarity or would like help, please reach out to @jsanc623 or open an Issue with your question/concern.

In particular, this community seeks the following types of contributions:

  • Ideas: participate in an issue thread or start your own to have your voice heard
  • Resources: submit a pull request to add to RESOURCES.md with links to related content
  • Outline sections: help us ensure that this repository is comprehensive. if there is a topic that is overlooked, please add it, even if it is just a stub in the form of a header and single sentence. Initially, most things fall into this category
  • Writing: contribute your expertise in an area by helping us expand the included content
  • Copy editing: fix typos, clarify language, and generally improve the quality of the content
  • Formatting: help keep content easy to read with consistent formatting

Conduct

We are committed to providing a friendly, safe and welcoming environment for all regardless of religion, ethnicity, gender, sexual orientation, disability, or other personal characteristic.

Please be kind and courteous. There's no need to be mean or rude. Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer, merely an optimal answer given a set of values and circumstances.

Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.

We will exclude you from interaction if you insult, demean or harass anyone.

Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact the core team immediately. Whether you're a regular contributor or a newcomer, we care about you, and we've got your back.

Likewise, any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.

Communication

GitHub Issues are the primary way for communicating about specific proposed changes to this project.

Please follow the conduct guidelines above. Language issues are often contentious, and we'd like to keep discussion brief, civil and focused on what we're actually doing, not wandering off into too much imaginary stuff.