Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.34 KB

CONTRIBUTING.org

File metadata and controls

51 lines (38 loc) · 2.34 KB
Raw

How to contribute?

Thank you for your interest in contributing to this project, it is extremely appreciated.

Submitting changes

Please, send a GitHub Pull Request (PR) to sparky-game/sparky with a clear list of what you’ve done (read more about PRs). The best place to start is to fork the repository to your personal profile, and start working from there.

Please, follow our coding conventions below and make sure all of your commits are atomic (one feature per commit) and have descriptive messages and an optional description (if needed). One-line messages are fine for small changes, but bigger changes should look like this:

git commit -s -m "Commit subject
>
> A paragraph describing what changed and its impact."

Coding conventions

Start reading our code and you’ll get the hang of it. We optimize for readabillity, but not compromising on its looks:

  • We indent using two spaces (soft tabs)
  • We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]) and around operators (x += 1, not x+=1)
  • This is free and 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.

For more information, see CODE_OF_CONDUCT.md.

Thanks a lot. Yours faithfully,

Wasym A. Alonso