Contributing

Contributing

To contribute, simply post an issue to the issue tracker. That it is reporting an existing bug or proposing new feature, I'll consider it and respond to you.

If you want to contribute in code form. Please post an issue first, so we can evaluate together how possible the change is, and what needs to be done.

There is currently no real code checking going on, but here are some general guidelines.

• If you submit Python code, try to be PEP8 as much as possible. Use pylint with the errors that were disabled in lib/scraper/main.py. I won't hold it against you if there is a couple pylint errors.

• If you submit Coffeescript code, follow those instructions:

  • Use 4 spaces for tabs.
  • Do not go beyond the 80th character column.
  • Use return statements rather than writing your return variable at the end of the function.
  • Always use parenthesis for function calls AND function definitions. (Exception being if you are writing views extending the space-pen-view classes)
  • Comment all functions that have more than 5 lines of code.
  • Use classes properly.

In general, also write how you test if your new functionality works, and what that new functionality adds to the package.