Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

24 lines (19 loc) · 1.36 KB

How to contribute

Hey, thanks for your interest in BitGlitter. Our current build is the just the beginning of what we want to accomplish. If you find this project as exciting as we do and wish to contribute, you can play a major role in the direction and evolution of what BitGlitter can become. Visit the below links to learn more!

Here's a few important resources:

  • BitGlitter Wikipedia - A continually growing resource for this project. Includes guides, roadmaps, and more.
  • Discord Channel - This is the nerve center of BitGlitter. It's highly recommended you join if you're interested in contributing!

Coding conventions

Check out our current code in master to get a feel for what we're looking for. We optimize for readability.

  • Please adequately describe the variable, function, or class in a way where it's immediately understandable what it is or what it does.
  • Use spacing to divide different logical parts of functions or behavior. This greatly helps with readability!
  • For any sufficiently complicated piece of code, please include dosctrings inside of the object, to better explain what it does.
  • camelCase is what's used for naming variables and functions.

More may be added if anything arises. Feel free to make a suggestion if you think I'm missing anything important! Thanks!