Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 3.67 KB

Contributing Guidelines

This document contains some guidelines for your making of contributions in this repository. At present, the author would rather have your contribution than not, if following these guidelines would effectuate you not making a contribution.

Primarily, aim to follow GitHub's community guidelines:

GitHub Community Guidelines:

The primary purpose of the GitHub community is to collaborate on software projects. We are committed to maintaining a community where users are free to express themselves and challenge one another's ideas, both technical and otherwise. At the same time, it's important that users remain respectful and allow space for others to contribute openly. In order to foster both a safe and productive environment, we encourage our community members to look to these guidelines to inform how they interact on our platform. Below, you’ll find some suggestions for how to have successful interactions as a valued member of the GitHub community.

  • Be welcoming and open-minded - New users join our community each day. Some are well-established developers, while others are just beginning. Be open to other ideas and experience levels. Make room for opinions other than your own and be welcoming to new collaborators and those just getting started.
  • Be respectful - Working in a collaborative environment means disagreements may happen. But remember to criticize ideas, not people. Share thoughtful, constructive criticism and be courteous to those you interact with. If you’re unable to engage respectfully, consider taking a step back or using some of our moderation tools to deescalate a tense situation.
  • Be empathetic - GitHub is a global community with people from a wide variety of backgrounds and perspectives, many of which may not be your own. Try to put yourself in others’ shoes and understand their feelings before you address them. Do your best to help make GitHub a community where others feel safe to make contributions, participate in discussions, and share different ideas.

Secondarily, aim to follow these guidelines1, as outlined by the author:

  • Use Evidence: Please attempt to back suggestions, contributions, code changes, and feature requests with evidence, such as relevant documentation, benchmarks, research papers, or conversations, among other things.
  • Transparency: Please attempt to maintain transparency in discussions by clearly state your motivations, assumptions, and any limitations in your contributions or suggestions. Be explicit about areas where you are uncertain or where your evidence is incomplete, specifying the degree of uncertainty where possible.
  • Adherence To Standards: Please attempt to follow existing standards or best practices relevant to the project, tools, or procedures to ensure consistency and readability.
  • Prioritize Impact: Please attempt to consider how your contributions affect the project's broader goals, integration with other tools or workflows, and long-term implications. Focus on improving the project's quality, usability, and performance. Reflect on its role within the context of civilization and strive to minimize harm or wasted effort.
  • Maintain Integrity: Do not intentionally misrepresent data, results, or contributions. Please always strive for epistemic rigor, accuracy, and honesty.

Footnotes

  1. The author welcomes, as is the case with most (all?) of the author's work, comments from the audience on these guidelines. The author is open to revising these contribution guidelines with suggestions engendered via reasonable criticism and discussion. ↩