Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 2.84 KB

How to contribute

I'm really glad you're reading this, because i need volunteer developers to help this project come to fruition.

If you haven't already, come find me in Linkedin #ertezatawsif. I want you working on things you're excited about.

Here are some important resources:

Testing

I have a handful of Cucumber features, but most of my testbed consists of C language examples. Please write C language examples for new code you create.

Submitting changes

Please send a GitHub Pull Request to ertezatawsif with a clear list of what you've done (read more about pull requests). When you send a pull request, i will love you forever if you include C language examples. I can always use more test coverage. Please follow my coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

> git commit .m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact"

Coding conventions

Start reading my code and you'll get the hang of it. I optimize for readability:

  • I indent using two spaces (no tabs).
  • I use HAML for all views.
  • I avoid logic in views, putting HTML generators into helpers.
  • I ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]), around operators (x += 1, not x+=1), and around hash arrows.
  • 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.
  • So that i can consistently serve images from the CDN, always use image_path or image_tag when referring to images. Never prepend "/images/" when using image_path or image_tag.
  • Also for the CDN, always use cwd-relative paths rather than root-relative paths in image URLs in any CSS. So instead of url('/images/image.gif'), use url('../images/image.gif').

Thanks, Erteza Tawsif Efaz, Electrical Engineer.