Skip to content

Latest commit

 

History

History
64 lines (49 loc) · 4.65 KB

CONTRIBUTING.md

File metadata and controls

64 lines (49 loc) · 4.65 KB

Etiquette Regarding Communication

When requesting support, try to remember that we are all volunteers that have lives outside of this project and none of us are paid to ensure things work for you, so please be considerate of others' time when you are asking for things. Many of us have families/friends/work/university that also need time as well and only have so much time to give on a daily basis. We will do what we can to provide support when folks are running into issues, but you may have to wait, so a little consideration and patience will be welcome. After all, you are using a pretty good tool without cost. It may not be perfect (yet), and we know that.

Adapted from choclatey

TLDR: Remember the human - reddit.

Defining a contribution

You are a contributor if you...

  • have made at least one pull request which has been accepted
  • are/were a member of the github organization
  • have made changes to the wiki which haven't been reverted

How to use github

Lupus590 made a tutorial on the forums

Prefered format for marking things to do in code/designs

TODO: <short description of thing to do This can be followed by a few more details, it may be helpful if your editor highlights the TODO: tag

Prefered format for git commit messages

Capitalized, short (50 chars or less) summary

More detailed explanatory text, if necessary.

Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
or "Fixes bug."  This convention matches up with commit messages generated
by commands like git merge and git revert.

- Bullet points are okay, you can use a hyphen or asterisk, but it must be followed by a
  single space, with blank lines in between

- Here is a second bullet point to demostate

adapted from this blog

General

  • The master branch should always build (even if it does nothing), if you are making a new feature then make it in a new branch. See the GitHub Flow for more information.
  • Follow styling sheet (provisional below)
  • Too many comments are better than too few, if a comment is exstanious then I ( @Lupus590 ) will remove it. I can't add comments for you though.
  • This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible. (Stolen from here)
  • If your contibution is in the todo list then please put a x in the box in TODO.md
  • Try to keep commits descriptive (I will admit that I don't always do this)
  • Do lots of small commits over one big one, it's easier for others to contribute with you and easier to revert parts
  • Pull requests: if it's all related then it can all go together, just make sure it's not all one big commit (see above) I can revert parts I don't like later. As to deciding what's related, use your best judgment.
  • This project is under the MIT License. Any code contributions you make must be made under a compatible license.
  • Contributers should document and publish their work in a way that allows another contributor to pick up on it if the original contributer stops working on the project due to any reason.

Documentation Generation

Start here for basic syntax

Additional syntax examples

Some notes: