Issues and how to post an issue

[Wilfongjt]

Writing a good issue can be daunting.

The best thing to do is just blurt it out there and let your collaborators ask questions and give you feedback.

Don't be afraid to modify your original issue.

• Most of the time we know we have an issue but we don't know the cause or how to describe it. Getting it going is more important than perfection.
• Write the initial issue and then modify it as the comments come in.
• A good issue will address, integrate and clarify based on the comments.
• Expect others to rewrite or edit your original posting. We have to keep things moving.

Break up big issues...slowly

More often than not an issue is just the tip of the iceberg. The natural process is to break up larger issues into smaller issues...Resist the urge to add another issue until the solution is clear. Instead make a list of the parts until a solution presents itself.

Lists are good

• bullets are good

Take a look at this article:

https://medium.com/nyc-planning-digital/writing-a-proper-github-issue-97427d62a20f