Skip to content

Latest commit

 

History

History
47 lines (39 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

47 lines (39 loc) · 3.14 KB

Guidelines for Contributing to CraftOS-Standards

Welcome, fellow developer! First off, make yourself familiar with the tutorial. It's a long read, so enjoy it with some ☕. If you'd like to create new standards, the tutorial should actually give you all you will need to know. Thanks for helping us out by standardizing something awesome!

A Note on Licensing

All standards published here on CraftOS-Standards are licensed under the GNU Free Documentation License. This includes all code examples. For the sake of open source software and simplicity alike, libraries for dealing with your standard should also be licensed under similar FOSS licenses. After all, licensing official utilities for an open source standard under a closed source license wouldn't make much sense.

Getting Started: Becoming a CraftOS-Standards Collaborator

If, for some reason, you'd like to join our amazing team of collaborators, you will need to know a few more things about how this repository works. Great news! We wrote them down here so you won't have to bother us about the details.

Repository Organization

Collaborators take care of everything, and are also the mods of our Gitter chat. As a collaborator, you will assign labels to Issues, help users who are proposing a standard with their Markdown documentation (as in, help them make it follow the template) and watch out for new pull requests that pop up every day. When on Gitter, you will be in charge of keeping the conversation on-topic. You will also provide help to users asking for it.

If you really want to become a collaborator, here is a checklist of what you need to do before asking @oeed to add you to the team as a collaborator:

  • Make sure you are a Markdown master
  • You really have to know the guide by heart. Read the README as well
  • Watch this repository
  • Look at some of the accepted PRs to see what a perfect proposal looks like
  • Look at some of the rejected PRs as well, to see what we don't want to see here. If you'll become a contributor, chances are that you'll meet a lot of similar pull requests!
  • Feel free to discuss any issues and PRs even if you aren't a contributor (yet)!

We try hard to stick to the "Successful git Branching Model", which means that major changes happen off the (default) master branch.