Skip to content

Latest commit

 

History

History
executable file
·
55 lines (41 loc) · 5.61 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
55 lines (41 loc) · 5.61 KB
Raw

Contributing

This document lays out exactly how you can contribute to iCloud Document Sync. Thanks for contributing!

How to Contribute - Issues

Found something that needs to be improved or fixed? Here's the best way to let everyone know about issues, bugs, possible new features, or just ask questions.

  1. Sign up for a GitHub Account
  2. Star this repository (so you can follow changes and find it easily)
  3. Look through the issues (opened or closed) for iCloud Document Sync to see if your issue has already been fixed, answered, or is being fixed
  4. Create a new issue from the issues tab on the right side of the screen

How to Contribute - Changes

Want to make a change to this project? Maybe you have a great idea, a new feature, bug fix, or something else. Here's the best way to contribute changes to the project.

  1. Sign up for a GitHub Account
  2. Star this repository (so you can follow changes and find it easily)
  3. Fork this repository and clone your fork onto your computer
  4. Make changes to the forked repo (you'll probably want to change the iCloud.m and iCloud.h files)
  5. Build the files, fix any errors, debug, test debug some more, build again
  6. Build the Framework and Documentation (refer to instructions below)
  7. Commit and then push all your changes up to your forked GitHub repo
  8. Submit a pull request from your forked GitHub repo into the main repo. Your pull request will then be reviewed and possibly accepted if everything looks good

Code Guidelines

Before submitting any code changes, read over the code / syntax guidelines to make sure everything you write matches the appropriate coding style. The Objective-C Coding Guidelines are available on GitHub.

Building the Framework

Building the Framework for iCloud is easy, just follow these simple steps:

  1. Make any changes to the project and build it with the iCloud target selected.
  2. When you've finished making changes and testing, select the Framework target from the scheme selector in the upper-left corner of Xcode. Click on Build / Run. Xcode will generate the framework and write it to the project folder.

Documentation Guidelines

Before submitting any changes, make sure that you've documented those changes. The changes you make should be noted in the Changelog.md file. If necessary, make the appropriate updates in the Readme.md file. You should also write appropriate documentation in the code (using comments). You can use documentation comments to create and modify documentation. Always write the documentation comments in the header, above the related method, property, etc. Write regular comments with your code in the implementation too. Here's an example of a documentation comment:

/// One line documentation comments can use the triple forward slash
@property (strong) NSObject *object;

/** Multi-line documentation comments can use the forward slash with a double asterisk at the beginning and a single asterisk at the end.
    @description Use different keys inside of a multi-line documentation comment to specify various aspects of a method. There are many available keys that Xcode recognizes: @description, @param, @return, @deprecated, @warning, etc. The documentation system also recognizes standard markdown formatting within comments. When building the documentation, this information will be appropriately formatted in Xcode and the Document Browser.

    @param parameterName Parameter Description. The @param key should be used for each parameter in a method. Make sure to describe exactly what the parameter does and if it can be nil or not.
    @return Return value. Use the @return key to specify a return value of a method. */
- (BOOL)alwaysWriteDocumentCommentsAboveMethods:(NSObject *)paramName;

Building the Documentation

Documentation is a fundamental portion of iCloud Document Sync. When you make changes to iCloud Document Sync (especially breaking changes), those changes should be documented (along with any additions or removals). You'll need to document changes in a few places (may vary by case): Readme.md, Changelog.md, and the DocSet bundle within the Documentation folder. This section discusses how to build the documentation through Xcode for the DocSet.

  1. Make any changes to the project and build it with the iCloud target selected.
  2. Download and install the Appledoc project from GitHub to generate documentation. The appledoc script must be installed in its default location (/usr/local/bin/appledoc for the documentation build to succeed.
  3. When you've finished making changes and testing, select the Documentation target from the scheme selector in the upper-left corner of Xcode. Click on Build / Run. Xcode will generate the framework and related documentation. Some duplicate files are deleted using a build script.
  4. The updated docset file, a raw html folder, and a publish information folder should be written to the project Documentation Folder.

What to Contribute

Contribute anything, we're open to ideas! Although if you're looking for a little more structure, you can go through the open issues on GitHub or look at the known issues in the Releases documentation. And if you're feeling adventurous, we're still working on adding OS X Compatibility (wink wink, nudge nudge).