[Docs] Contributing guide #3075

mbrookes · 2016-01-27T21:49:39Z

Closes #134.

oliviertassinari · 2016-01-27T21:50:30Z

Could we add a section on the docs that use CONTRIBUTING.md too?

mbrookes · 2016-01-27T21:52:03Z

Good idea. Where would it best fit?

newoga · 2016-01-27T21:57:00Z

CONTRIBUTING.md

+
+If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been [reported or fixed](https://github.com/callemall/material-ui/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aclosed). You can search through existing issues and PRs to see if someone's reported one similar to yours.
+
+Next, create a new issue that briefly explains the problem, and provides a bit of background as to the circumstances that triggered it, and spteps to reproduce it. A minimal example for code issues, or images or animated gifs for design issues can help understand your issue.


spteps -> steps

Would it be worth while to list some things that we general like to see in issues, maybe like these things?

bugs: browser, version, code example
feature request: screenshot/link to the spec

We've got some of those, but I'll add the rest.

oliviertassinari · 2016-01-27T21:57:55Z

I would add it under the Discover More section, close to the Community.

newoga · 2016-01-27T22:19:15Z

I think this a good start 👍 Much much much better than nothing. 😄

alitaheri · 2016-01-27T22:33:29Z

Thanks a lot for getting this done after so long 👍 👍 🎉

Regarding PR and issues. I think Open an Issue and Submit a Pull Request make more sense. What do you think guys?

mbrookes · 2016-01-27T22:56:48Z

@alitaheri Thanks!

I've made it Opening and Contributing respectively. Better, thanks.

mbrookes · 2016-01-27T23:02:02Z

@oliviertassinari I'm trying to get this working in the docs site, but I'm getting an error:

ERROR in ../CONTRIBUTING.md
Module parse failed: /Users/Matt/Projects/material-ui/CONTRIBUTING.md Line 1: Unexpected token ILLEGAL
You may need an appropriate loader to handle this file type.

Seems to be realted to ue to the import in Contributing.jsx. Is there something extra I need to do here? I looked at your recent PR for Showcase, and didn't see anything specific.

I can push the broken build if you wanted to take a look.

oliviertassinari · 2016-01-27T23:11:49Z

I'm getting a linting error:

Can you try to npm install --save-dev the markdown loader on the root folder?

mbrookes · 2016-01-28T00:04:53Z

Sorry, missed your reply earlier.

I realised it was to do with this: https://github.com/callemall/material-ui/blob/master/docs/webpack-dev-server.config.js#L99

I've removed that line for now. An alternative is to symlink to CONTRIBUTING.md from discover-more. (Or to add the root folder to include:, but I assume that's effectively the same as not having it at all.)

I also noticed there are some other stray directories in that file from the old docs layout, but out of scope to fix in this PR.

hai-cea · 2016-01-28T03:56:38Z

@mbrookes Thank you for pulling this together! I think we may want to add a section on where new contributors can start? Like the project roadmap and the up for grabs issue tag.

mbrookes · 2016-01-28T10:06:22Z

I'll put that in, although in reality most people will want to scratch their own itch (bug / feature) before contributing more generally.

mbrookes · 2016-01-28T11:09:49Z

Okay, I've aded the intro and a roadmap section. There are only three issues tagged up-for-grabs, and aside from those with current PRs, pretty much everything is up for grabs anyway!

oliviertassinari · 2016-01-28T13:24:35Z

CONTRIBUTING.md

+npm run start
+```
+You can now access
+If you find you need to use `console.log()` or `debugger`, you will need to temporarily disable linting. Simply comment out the [`preLoaders` section](https://github.com/callemall/material-ui/blob/master/docs/webpack-dev-server.config.js#L62) of `docs/webpack-dev-server.config.js`


This was a pain in the ass for me. We should find a way to make any eslint error not blocking the webpack bundling.

oliviertassinari · 2016-01-28T13:29:15Z

@mbrookes That's a really good start 👍. I think that it would be good to add a link to CONTRIBUTING.md in the Contribute section of README.md.

mbrookes · 2016-01-28T13:47:00Z

@oliviertassinari Done. If there are no further suggestions, I think we should squash and merge. We can always come back later if there's anything else.

oliviertassinari · 2016-01-28T15:46:07Z

@mbrookes Let's squash down and merge 🎉.

Add CONTRIBUTING to README

[Docs] Contributing guide

oliviertassinari · 2016-01-28T18:13:06Z

@mbrookes Thanks!

alitaheri · 2016-01-28T18:32:49Z

Finally 👍 Yeeey 🎉 🎈 Thanks a lot 😁

newoga reviewed Jan 27, 2016
View reviewed changes

mbrookes added docs Improvements or additions to the documentation PR: Needs Review labels Jan 28, 2016

newoga changed the title ~~[WIP][Docs] Contirbuting guide~~ [WIP][Docs] Contributing guide Jan 28, 2016

oliviertassinari reviewed Jan 28, 2016
View reviewed changes

mbrookes added 2 commits January 28, 2016 17:24

[Docs] Contirbuting guide

7bbcbb6

[Docs] Add Contributing section to docs site.

09c7ac6

Add CONTRIBUTING to README

oliviertassinari added a commit that referenced this pull request Jan 28, 2016

Merge pull request #3075 from mbrookes/contributing

3da3523

[Docs] Contributing guide

oliviertassinari merged commit 3da3523 into mui:master Jan 28, 2016

oliviertassinari changed the title ~~[WIP][Docs] Contributing guide~~ [Docs] Contributing guide Jan 28, 2016

mbrookes added PR: Review Accepted and removed PR: Needs Review labels Jan 29, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Contributing guide #3075

[Docs] Contributing guide #3075

mbrookes commented Jan 27, 2016

oliviertassinari commented Jan 27, 2016

mbrookes commented Jan 27, 2016

newoga Jan 27, 2016

newoga Jan 27, 2016

mbrookes Jan 27, 2016

oliviertassinari commented Jan 27, 2016

newoga commented Jan 27, 2016

alitaheri commented Jan 27, 2016

mbrookes commented Jan 27, 2016

mbrookes commented Jan 27, 2016

oliviertassinari commented Jan 27, 2016

mbrookes commented Jan 28, 2016

hai-cea commented Jan 28, 2016

mbrookes commented Jan 28, 2016

mbrookes commented Jan 28, 2016

oliviertassinari Jan 28, 2016

oliviertassinari commented Jan 28, 2016

mbrookes commented Jan 28, 2016

oliviertassinari commented Jan 28, 2016

oliviertassinari commented Jan 28, 2016

alitaheri commented Jan 28, 2016


		If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been [reported or fixed](https://github.com/callemall/material-ui/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aclosed). You can search through existing issues and PRs to see if someone's reported one similar to yours.

		Next, create a new issue that briefly explains the problem, and provides a bit of background as to the circumstances that triggered it, and spteps to reproduce it. A minimal example for code issues, or images or animated gifs for design issues can help understand your issue.

[Docs] Contributing guide #3075

[Docs] Contributing guide #3075

Conversation

mbrookes commented Jan 27, 2016

oliviertassinari commented Jan 27, 2016

mbrookes commented Jan 27, 2016

newoga Jan 27, 2016

Choose a reason for hiding this comment

newoga Jan 27, 2016

Choose a reason for hiding this comment

mbrookes Jan 27, 2016

Choose a reason for hiding this comment

oliviertassinari commented Jan 27, 2016

newoga commented Jan 27, 2016

alitaheri commented Jan 27, 2016

mbrookes commented Jan 27, 2016

mbrookes commented Jan 27, 2016

oliviertassinari commented Jan 27, 2016

mbrookes commented Jan 28, 2016

hai-cea commented Jan 28, 2016

mbrookes commented Jan 28, 2016

mbrookes commented Jan 28, 2016

oliviertassinari Jan 28, 2016

Choose a reason for hiding this comment

oliviertassinari commented Jan 28, 2016

mbrookes commented Jan 28, 2016

oliviertassinari commented Jan 28, 2016

oliviertassinari commented Jan 28, 2016

alitaheri commented Jan 28, 2016