How to contribute

Prerequisites:

  • Familiarity with GitHub PRs (pull requests) and issues.
  • Knowledge of markdown for editing .md documents.
  • Understanding of the basics of Jekyll.

Types of contributions

Here are a few of the types of contributions that we’re looking for. Have an idea but it doesn’t fit into this list? Make an issue for it in the issue’s queue foor the project.

Ideas

Participate in an issues thread or start your own to have your voice heard.

Design

Create mockups & prototypes for new and revised sections of the site.

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.

Code

Fix issues or contribute new features to this or any related projects.

Steps to contributing

  • Fork the repository
  • Create a branch for your changes
  • Add yourself as a contributor.
    • make a file in the _contributors directory with your full name as the file name using the pattern firstlast.md
    • look at other contributor files to see what you should include.
  • Make the changes you’d like to contribute. See the “types of contributions” list above to learn more about what we’re looking for
  • Submit a pull request

Conduct

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

On IRC, please avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.

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. That is not welcome behaviour. We interpret the term “harassment” as including the definition in the Citizen Code of Conduct; if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don’t tolerate behavior that excludes people in socially marginalized groups.

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 one of the channel ops or any of the core team immediately. Whether you’re a regular contributor or a newcomer, we care about making this community a safe place for you and we’ve got your back.

Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior 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 in all communication about this project. 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.