DEV/material-components_material-components-ios
1
0
Fork 0
mirror of https://github.com/material-components/material-components-ios.git synced 2026-02-20 08:27:32 +08:00
Code Issues Packages Projects Releases Wiki Activity
material-components_materia.../contributing/README.md
Omer Ziv a2cee6a911 Update README.md
2016-12-20 15:16:32 -05:00

2.3 KiB
Raw Blame History

General Contributing Guidelines

The Material Components contributing policies and procedures can be found in the main Material Components documentation repository’s contributing page.

iOS-specific Additions

The iOS team also abides by the following policy items:

Code Conventions

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.

Component Checklist

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.

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.

Deprecation

See deprecation_policy.md for details.

Hotfixing

Occasionally it is necessary to hotfix the framework. See hotfixing.md for details.

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 "is:Help wanted" label.

The small print

Contributions made by corporations are covered by a different agreement than the one above, the Software Grant and Corporate Contributor License Agreement.

Useful Links