Material-ui: [PR to add a site] that uses material-ui

Created on 26 May 2017  路  6Comments  路  Source: mui-org/material-ui

I have created an advanced UI using material-ui. I want to add my project to your /showcase page.

You say here

Please submit a pull request on GitHub to update this page!

Ok. But how? I have forked and cloned the project. But where is that /showcase page? How do I add my site?

question

All 6 comments

You can find the showcase page right here. Yes, you need to fork the repository if you want to submit a PR.
Thanks for using Material-UI 馃槃 .

My cloned version has only 4 items in an appList array. Please see the screenshot. But from the link that you provided there are much more items.

1) Why is it so? What do I do wrong?
2) How do I add my app's screenshot to your images/showcase/ folder?

  {
    title: 'SplitMe',
    author: 'Olivier Tassinari',
    img: 'images/showcase/splitme.png', // <== this image
    link: 'https://splitme.net/',
  },

Thank you

react_material-ui_docs_src_app_components_pages_discover-more_showcase jsx - sublime text unregistered 2017-05-27 07 45 28

My cloned version has only 4 items

You need to pull the latest changes from the remote git repository.

How do?

Simply pick a merged PR that add a new project into the showcase and follow the same procedure.
You have the history here. Here is the last PR.

Q: _My cloned version has only 4 items_
A: You need to pull the latest changes from the remote git repository.

Here is how to do it:

  1. https://stackoverflow.com/questions/3903817/pull-new-updates-from-original-github-repository-into-forked-github-repository
  2. https://help.github.com/articles/fork-a-repo/#keep-your-fork-synced - how to set up a sync
  3. https://help.github.com/articles/syncing-a-fork/ - how to perform a sync

Q: Do I need to run add and commit commands before I push changes to upstream?

Explanation:

I have made my changes. And when I run git status, I have files that are modified and untracked.

react_material-ui 2017-05-29 11 43 02

The step 4 of your contributing rules (see below) says I need to run git push --set-upstream origin my-topic-branch right after my changes are made. So it is not clear if I need to run add and commit commands before pushing my changes to upstream.

My question is, do I need to run add and commit commands before I push changes?

  1. Fork the Material-UI repository on Github
  2. Clone your fork to your local machine git clone --depth 1 [email protected]:<yourname>/material-ui.git
    (For the next branch, add the -b next flag to the above command.)
  3. Create a branch git checkout -b my-topic-branch
  4. Make your changes, lint, then push to github with git push --set-upstream origin my-topic-branch.
  5. Visit github and make your pull request.
Was this page helpful?
0 / 5 - 0 ratings