Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 2.87 KB

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

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 build
  6. Run yarn run dev
  7. Open http://localhost:8081 in your web browser
  8. Make changes to components in src/
  9. Add the components to pages in /pages (Pages are mapped to routes for our documentation)
  10. Add a link to your new component page in index.js
  11. Install now if you do not already have it installed.
  12. Run yarn now-build to get a shareable link to the updated docs copied to your clipboard.
  13. Run yarn contributor to add yourself to the contributors doc (!).
  14. Open a PR, making sure to include the link to the updated docs so others can see your wonderful changes.
  15. Profit :D

Contribution review process

This repo is currently maintained by the engineering team at Collete Lab. 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 Material Styled Components take place on this repository's Issues and Pull Requests sections.

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