New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add to contributor docs on how to format issues #245

Closed
juliaelman opened this Issue Feb 17, 2015 · 6 comments

Comments

Projects
None yet
3 participants
@juliaelman
Contributor

juliaelman commented Feb 17, 2015

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

  • Add clearer instructions on reading the contributors section on the docs before submitting an issue.
  • Add either a link to the template on Github and/or an example of the template in the docs.
  • Complete/Fix

Additional Info
Original request was based off this comment by @lozandier: #240 (comment)

@pamelafox

This comment has been minimized.

Show comment
Hide comment
@pamelafox

pamelafox Feb 17, 2015

Member

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?

Member

pamelafox commented Feb 17, 2015

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

This comment has been minimized.

Show comment
Hide comment
@juliaelman

juliaelman Feb 17, 2015

Contributor

@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 🎉

Contributor

juliaelman commented Feb 17, 2015

@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 🎉

@kstack7

This comment has been minimized.

Show comment
Hide comment
@kstack7

kstack7 Feb 17, 2015

Contributor

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

Definitely helps to get feedback on what's easier

Contributor

kstack7 commented Feb 17, 2015

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

Definitely helps to get feedback on what's easier

@juliaelman

This comment has been minimized.

Show comment
Hide comment
@juliaelman

juliaelman Feb 17, 2015

Contributor

@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. 👍

Contributor

juliaelman commented Feb 17, 2015

@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. 👍

@kstack7

This comment has been minimized.

Show comment
Hide comment
@kstack7

kstack7 May 4, 2015

Contributor

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!

Contributor

kstack7 commented May 4, 2015

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

This comment has been minimized.

Show comment
Hide comment
@kstack7

kstack7 May 13, 2015

Contributor

Closed with #323

Contributor

kstack7 commented May 13, 2015

Closed with #323

@kstack7 kstack7 closed this May 13, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment