Developer Resources

This page is intended to help people contribute code to the MachBlog project. If you correct a bug in the application or add a new feature, we hope you'll take the time to contribute those changes back to the community. In order to make that as painless a process (for all of us) as possible, please try to stick to the following guidelines:

IDE settings

  • Preserve tabs (make sure your editor is not set to replace tabs with spaces)
  • Disable automatic trimming of trailing whitespace
  • Do not use word-wrap; put a hard break in after a reasonable line-length

Coding-related conventions

  • Don't use hungarian notation
  • camelCaseEverything (variable names, file names). use InitialCap for CFC file names.
  • Pay VERY close attention to case sensitivity EVERYWHERE even where you think it won't matter (makes for more readable code even if you run on Windows where case doesn't matter so much)