Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 4.59 KB

README.md

File metadata and controls

75 lines (48 loc) · 4.59 KB
Raw

How to Contribute

MDC React is an open source project, so we encourage contributions! If you are looking for a bug to fix, check out Help Wanted Issues on GitHub. Otherwise please open a new issue.

Please follow all our Code of Conduct Guide.

Fixing a Bug or Adding a Feature

MDC React's goal is to build in parity of MDC Web. MDCR's features should have a 1:1 mapping within the constraints of React. If there is part of the API you disagree with please open a new issue. Depending on the content it may fall to MDC Web's work queue, which MDC React will add in a later release.

When in doubt open an issue. We're here to hear you!

Add a Feature

We consider any new API to be a new feature. An API is any of the following:

  • Update to React Component APIs
  • Prop updates on React Component
  • Adding a new component

If changes fall under these categories or you'd like to add a new component please open an issue first. The team wants to collaborate with you before you dive head first into making changes and updates.

If the changes don't fall into the above categories, or fix an existing feature, it most likely will fall into MDC Web

Fixing Bugs

  • If the issue is a small doc change (READMEs, documentation, etc.) please go ahead and open a pull request.
  • If the changes you want to perform are under 10 - 20 lines of code, please open a pull request.
  • Anything larger or change to an API will require an issue to be opened first.

Commit Message Format

The final commit message to the mdc-foo package, for GitHub issue 1234, should look like this:

# for a fix to an issue
fix(component-name): Short description of fix

# for a new feature
feat(component-name): Short description of feature

# for a doc update
docs(component-name): Short description of doc changes

This commit message is pulled into our CHANGELOG when we release and is based on Angular's Git commit guidelines. If you have any difficulty, please reach out to us on Discord or add a comment to the GitHub issue or PR.

Pull Requests

Pull requests should meet the following criteria:

  • PRs should be focused! PRs should focus on fixing one issue or an additional feature. Anything extra requires another PR.
  • If there is an existing issue please refer to it in the description of your PR.
  • Please also add notes/description about what your changes are trying to achieve (or anything you've learned). Brevity appreciated.

Process

Before opening a PR, it should be up to date with targeted release (rc<release_number> ie. rc0.7.0, rc0.8.0, etc.). In most cases it will never be branched from master.

Checklist:

  • all unit tests pass. Please read the tests doc for further instructions.
  • ensure you have appropriate test coverage tests doc.
  • lint passes, which you can read up in tests doc.
  • screenshot tests pass. Please read screenshot testing for instructions.
  • descriptions about your changes.
  • sign your PR (comment in PR "I signed it"). Read cla/google.

Once you have passed all checks, the process is as follows:

  1. Ping one of the admins (@bonniezhou, @moog16) in the PR to notify us its ready for review.
  2. We will either approve, request changes, or explain why we can't accept these changes. And we'll work from there.
  3. Assuming approval, one of the admins will open a new PR so that tests are run on TravisCI.
  4. Once tests pass, an admin will close the Test PR and merge your PR.