The Material Components contributing policies and procedures can be found in the main Material Components documentation repository’s contributing page.
The iOS team also abides by the following policy items:
MDC follows certain coding styles and conventions for its code to help everyone easily read, review, and understand our code. Please follow these conventions when submitting pull requests.
All components should pass these checks or give a compelling reason why they shouldn’t.
There is a great script that checks for some of these criteria. Run it regularly during development. It will also be run by the continuous integration system when you make a pull request. If the script fails at that point, the pull request will be blocked.
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.
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.
See deprecation_policy.md for details.
Occasionally it is necessary to hotfix the framework. See hotfixing.md for details.
MDC-iOS uses GitHub to file and track issues. To find an issue to work on, filter the issues list by the "is:New Collaborator Friendly" label.
Contributions made by corporations are covered by a different agreement than the one above, the Software Grant and Corporate Contributor License Agreement.
- 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)