CONTRIBUTING.md

Contributing to MacDown

Coding Style

All style rules are enforced under all circumstances except for external dependencies.

Objective-C

The 80-column Rule

All code should obey the 80-column rule.

Exception: If a URL in a comment is too long, it can go over the limit. This happens a lot for Apple’s official documentation. Remember, however, that many websites offer alternative, shorter URL forms that are permanent. For example:

• The title slug in StackOverflow (and other StackExchange sites) URLs can be ommitted. The following two are equivalent:

  http://stackoverflow.com/questions/13155612/how-does-one-eliminate-objective-c-try-catch-blocks-like-this http://stackoverflow.com/questions/13155612

• The commit hash in GitHub commit page’s URL can be shortened. The followings are all equivalent:

  https://github.com/uranusjr/macdown/commit/1612abb9dbd24113751958777a49cffc6767989c https://github.com/uranusjr/macdown/commit/1612abb9dbd24 https://github.com/uranusjr/macdown/commit/1612abb

Code Blocks

• Braces go in separate lines. (Allman style.)
• If only one statement is contained inside the block, omit braces unless...
  • This is part of a if-(else if-)else structure. All brace styles in the same structure should match (i.e. either non or all of them omit braces).

Stetements Inside if, while, etc.

• Prefer implicit boolean conversion when it makes sense.

  • if (str.length) is better than if (str.length != 0) if you wants to know whether a string is empty.
  • The same applies when checking for object nil-ness.
  • If what you want to compare against is zero as a number, not emptiness, such as for NSRange position, NSPoint coordinates, etc., do use the == 0/!= 0 expression.

• If statements need to span multiple lines, prefer putting logical operators in the beginning of the line.

  Yes:

  while (this_is_very_long
         || this_is_also_very_long)
  {
      // ...
  }

  No:

  while (this_is_very_long ||
         this_is_also_very_long)
  {
      // ...
  }

• If code alignment is ambiguious, add extra indentation.

  Yes:

  if (this_is_very_long
          || this_is_also_very_long)
      foo++;

  No:

  if (this_is_very_long
      || this_is_also_very_long)
      foo++;

  The above is not enforced (but recommended) if braces exist. Useful if you have a hard time fitting the statement into the 80-column constraint.

  Okay:

  if (this_is_very_long
      || this_is_very_very_truly_long)
  {
      foo++;
      bar--;
  }

Invisible Characters

Always use four spaces instead of tabs for indentation. Trailing whitespaces should be removed. You can turn on the Automatically trim trailing whitespace option in Xcode to let it do the job for you.

Try to ensure that there’s a trailing newline in the end of a file. This is not strictly enforced since there are not easy ways to do that (except checking manually), but I’d appriciate the effort.

Version Control

MacDown uses Git for source control, and is hosted on GitHub.

Commit Messages

General rules apply. If you absolutely need to, the first line of the message can go as long as 72 (instead of 50), but it must not exceed it.

Xcode’s commit window does not do a good job indicating whether your commit message is well-formed. I seldom use it personally, but if you do, you can check whether the commit message is good after you push to GitHub—If you see the first line of you commit message gets truncated, it is too long.

Pull Requests

Please rebase your branch to master when you submit the pull request. There can be some nagging bugs when Git tries to merge files that are not code, particularly .xib and project files. When in doubt, always consider splitting changes into smaller commits so that you won’t need to re-apply your changes when things break.

Under certain circumstances I may wish you perform furthur rebasing and/or squashing after you submit your pull request, or even perform them myself instead of merging your commits as-is. Don’t worry—you will always get full credits for your contribution.

More to Come

This style guide is a work in progress. Please feel free to ask is you have any questions about it. I’ll add more rules if there’s ambiguity.