Skip to content
This repository has been archived by the owner on Apr 7, 2020. It is now read-only.

Latest commit

 

History

History
75 lines (56 loc) · 5.31 KB

CONTRIBUTING.md

File metadata and controls

75 lines (56 loc) · 5.31 KB
Raw

Contributing to Styled Material Components

Welcome to Styled Material Components! We're so glad you're here. Please read the info below, and do not hesistate to contact us if you have any questions or concerns.

Table of Contents

  1. Issues and Contributions
  2. How to contribute
  3. Contribution review process
  4. Community
  5. [Resources and Terminology]

Issues and Contributions

The easiest way to start contributing is to check out our current open Issues. Here you will find open issues that need to be implemented including but not limited to: features, enhancements, bug fixes, discussions, and questions. Issues we've identified as possible good places to start for first time contributors are labeled as "good first issue." Feel free to assign yourself to issues you are interested in tackling and open a PR when you feel like your code satisfies the open issue.

Additionally, there are also many ways you can directly contribute, such as:

  • Fix typos, inconsistencies, or inaccuracies in the documentation
  • Comment and join discussions on existing Issues and Pull Requests
  • Add issues when features, enhancements, bugs, discussions, or questions are identified that are not already open

How to contribute

  1. Fork this repo
  2. Create a remote upstream to the original project repository with: git remote add upstream https://github.com/ConciergeAuctions/styled-material-components.git
  3. Create a new branch on your fork with a name relevant to what you are working on
  4. Run yarn install
  5. Run yarn run dev
  6. Open http://localhost:8081 in your web browser
  7. Make changes to components in src/
  8. Add the components to pages in /pages (Pages are mapped to routes for our documentation)
  9. Add a link to your new component page in index.js
  10. Open a PR
  11. Our danger script will build your application and post a link as a comment to view your work!
  12. Profit :D

Contribution review process

This repo is currently maintained by the engineering team at Merlin Labs. If you haven't heard from anyone in 10 days, feel free to bump the thread or @-mention a maintainer to review your contribution.

Community

Discussions about Styled Material Components take place on this repository's Issues and Pull Requests sections.

We also have an active #smc Slack Channel, and would love for you to join the discussion there. If you are having trouble accessing the channel please reach out to @ashwoodall to request access.

Anyone is welcome to join these conversations.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation. Please read more about conversation guidelines at our Code of Conduct

Follow us on Twitter to learn more about our open source initiatives and get involved with our community <3

Read more about contributing to the open source community on Github's fantastic Open Source Guides

Resources and Terminology

  • React is a component-based library for managing state and creating user interfaces.
  • styled-components Inspired by the component-based architecture of React, Max Stoiber and Glenn Maddern created a library, styled-components, that allows you to style your application using React components.
  • design language / design vocabulary: a set of design guidelines or principles that allow designers to create thematically consistent user interfaces.
  • Material Design is the name of a design language created by Google. Many of the Google applications you probably use (Gmail, YouTube, Inbox, Google Maps and many others) have implemented the Material Design guidelines.
    • material.io is the home page for Google's Material Design system.
  • Material Components is the name of Google's own UI implementation of their Material Design spec.
  • Material UI is a library that implements Google's Material Design, crafted in React components. If you want to create a React project using the popular Material Design guidelines, Material UI provides a component-based library that is designed to be used in a React application.
  • Styled Material Components (this library) creates a fresh implementation of Material Components, using Styled Components.
  • styled-material-components is the npm package for Styled Material Components.