Skip to content

Add to contributor docs on how to format issues #245

@juliasolorzano

Description

@juliasolorzano

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)

Activity

pamelafox

pamelafox commented on Feb 17, 2015

@pamelafox
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?

juliasolorzano

juliasolorzano commented on Feb 17, 2015

@juliasolorzano
Author

@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

kstack7 commented on Feb 17, 2015

@kstack7
Collaborator

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

Definitely helps to get feedback on what's easier

juliasolorzano

juliasolorzano commented on Feb 17, 2015

@juliasolorzano
Author

@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

kstack7 commented on May 4, 2015

@kstack7
Collaborator

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

kstack7 commented on May 13, 2015

@kstack7
Collaborator

Closed with #323

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @pamelafox@juliasolorzano@kstack7

        Issue actions

          Add to contributor docs on how to format issues · Issue #245 · girldevelopit/gdi-website