girldevelopit / gdi-website

This is the official repository for the Girl Develop It website.
https://girldevelopit.com
MIT License
310 stars 378 forks source link

Add to contributor docs on how to format issues #245

Closed juliaelman closed 9 years ago

juliaelman commented 9 years ago

Description There have been several instances where a contributor has needed to re-format their newly issue.

Ask Create a more seamless way for contributors to understand to use the #83 template when formatting issues.

To Do

Additional Info Original request was based off this comment by @lozandier: https://github.com/girldevelopit/gdi-new-site/issues/240#issuecomment-74574108

pamelafox commented 9 years ago

I think you could probably put the template inside ``` code formatting so that people could copy/paste the markdown? Or stick it in a gist?

juliaelman commented 9 years ago

@pamelafox +1 on the gist and making it easier for folks to copy/pasta. We probably also want take into consideration that folks might want to see what the final result will look too. #83 can serve as that example :tada:

kstack7 commented 9 years ago

@Cara-Jo offered her gist here: https://gist.github.com/Cara-Jo/ac8f3168db2a08317a13

Definitely helps to get feedback on what's easier

juliaelman commented 9 years ago

@kstack7 @Cara-Jo YES! Awesomeness. Since this issue is about adding to contributor docs, I think it'd be good to add that code into the docs. :+1:

kstack7 commented 9 years ago

I think this issue can be knocked out by adding a CONTRIBUTING.md file per @DBNess suggestion in #318 :)

I pushed the file to staging if anyone wants to review/check it out!

kstack7 commented 9 years ago

Closed with #323