General Contributing Guidelines
The Material Components contributing policies and procedures can be found in the main Material Components documentation repository’s
iOS-specific Additions
The iOS team also abides by the following policy items:
Code Conventions
MDC follows certain
Component Checklist
All components should pass
There is a
Issue and Pull Request Titles
Start the title with [ComponentName] to identify which component a change affects. Use [ComponentName|OtherComponentName] for commits affecting multiple components, which should be rare.
[FooBar] Removes the deprecated fooWithBar:(Bar*)bar method.
Pull request continuous integration for new contributors
Continuous integration will only be initiated automatically for the
All other pull requests must be labeled with kokoro:force-run by a member of the repo with write access in order for continuous integration to be initiated. This label must be added again each time the pull request has new commits pushed to it.
For Googlers:
Using assignee to indicate who should action on a PR
Since PRs on github permanently stay in the Changes requested state it is hard to tell when the author has addressed the concerns. By change the assignee to whomever still needs to action (review or modify/justify) we can more easily keep track of what needs attention in our PR queues.
- For a reviewer this means adding the author as an assignee once the review is finished.
- For an author it means adding back the reviewer (and removing themselves) as an assignee.
Deprecation
See
Finding an issue to work on
MDC-iOS uses GitHub to file and track issues.
To find an issue to work on, filter the issues list by the
Getting started
If you're new to iOS development and have a computer running OS X, these steps should help you get all the prerequisites. More experienced users may just need to see the last steps.
- We assume you already have installed on you mac
- Install
- To see your work within the catalog
- pod install --project-directory=catalog/
- open catalog/MDCCatalog.xcworkspace
- Navigate to the component you want to work on in Pods -> Development Pods -> Material Components -> <#component>.
- Run the MDCDragons target to see the full set of examples.
- Tests can also be run from the Product menu.
- To send us a change make a
Pull Requests fromyour own fork .
The small print
Contributions made by corporations are covered by a different agreement than the one above, the
Useful Links
How To Use MDC-iOS All Components Demo Apps MDC-iOS on Stack Overflow (external site)Material.io (external site)Material Design Guidelines (external site)