Skip to content

Commit 62a14f8

Browse files
authored
Merge pull request #569 from outoftime/readme-contributing
Improved contributing section in README
2 parents f128e2c + 6c349f5 commit 62a14f8

1 file changed

Lines changed: 25 additions & 2 deletions

File tree

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Popcode uses [**React**](https://facebook.github.io/react/) to render views,
7777
[**Redux**](http://redux.js.org/) to manage application state,
7878
[**Ace**](https://ace.c9.io/) as the code editor,
7979
[**Webpack**](https://webpack.github.io/) to package the client-side
80-
application, and [Babel](https://babeljs.io/) to compile ES2016+JSX into ES5.
80+
application, and [**Babel**](https://babeljs.io/) to compile ES2016+JSX into ES5.
8181

8282
Popcode detects code errors using
8383
[slowparse](https://github.com/mozilla/slowparse),
@@ -112,10 +112,33 @@ lifecycle of a user interaction:
112112

113113
## Contributing ##
114114

115-
Yes please! There are a [ton of ways](https://trello.com/b/ONaFg6wh/popcode)
115+
Yes please! There are a [ton of
116+
ways](https://github.com/popcodeorg/popcode/issues)
116117
Popcode could be made better. Pull requests, bug reports, feature suggestions
117118
are all very very welcome.
118119

120+
When you’re first getting started, I recommend picking an issue that’s [good for
121+
beginners](https://github.com/popcodeorg/popcode/issues?q=is%3Aopen+is%3Aissue+label%3Agood-for-beginner) so you can get your feet wet and make sure you can run a development environment smoothly.
122+
123+
Everyone is welcome to submit pull requests that implement a new feature or fix
124+
a bug that you’re particularly passionate about. But if you just want to help
125+
out and you’re looking for ideas, you’ve got lots of options. You might check
126+
out some of the
127+
[enhancements](https://github.com/popcodeorg/popcode/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement)
128+
that have been proposed, or maybe fix a
129+
[bug](https://github.com/popcodeorg/popcode/issues?q=is%3Aopen+is%3Aissue+label%3Abug).
130+
There’s also plenty of
131+
[UX](https://github.com/popcodeorg/popcode/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3Aux)
132+
and
133+
[design](https://github.com/popcodeorg/popcode/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3Adesign%20)
134+
work to do, if that’s more your speed. Or, if you’re more about tinkering with
135+
the guts, there’s lots of [development
136+
tooling](https://github.com/popcodeorg/popcode/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3Adevelopment-tooling),
137+
[deployment](https://github.com/popcodeorg/popcode/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3Adeployment),
138+
and
139+
[performance](https://github.com/popcodeorg/popcode/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3Aperformance)
140+
work to do.
141+
119142
### Running locally ###
120143

121144
Pretty easy. Just check out the code, then run:

0 commit comments

Comments
 (0)