0

August 29, 2016 AT 6:36 pm

45 GitHub Issues Dos and Don’ts

Jason Chen has a great blog post with simple advice for contributing to open source projects on GitHub.  In particular Jason talks about what to consider when opening issues, sending pull requests, and more to an open source project.  There’s lots of great advice like not adding on unrelated issues to an existing one.  Check out the blog post for all the tips like:

Do open one Issue for one issue.

Do open two Issues for two issues.

Do not tack on “Oh by the way here’s another problem I noticed” to an unrelated Issue.

Do keep facts and opinions separate, ideally facts first and opinions at the end. Facts include platform details, reproduction steps, and what you have tried. Opinions include speculations about root causes you have not investigated.

Do be specific, especially in reproduction steps. Instead of the instruction: “type some text,” be unambiguously specific with the instruction: “Type ‘Test’”. The bug might have to do with the shift key and it will not be reproduced by others repeatedly banging adsfasdfadsfasd. This is not a theoretical occurrence — underspecification remains one of the most common reasons valid issues get closed as not reproducible.

45 GitHub Issues Dos and Don’ts


Check out all the Circuit Playground Episodes! Our new kid’s show and subscribe!

Have an amazing project to share? Join the SHOW-AND-TELL every Wednesday night at 7:30pm ET on Google+ Hangouts.

Join us every Wednesday night at 8pm ET for Ask an Engineer!

Learn resistor values with Mho’s Resistance or get the best electronics calculator for engineers “Circuit Playground”Adafruit’s Apps!


Maker Business — HAX Hardware Trends 2017

Wearables — Tidy wires are happy wires

Electronics — Coin Cell Current

Biohacking — Circuit Board Borg Leg Tattoo Sleeve

Get the only spam-free daily newsletter about wearables, running a "maker business", electronic tips and more! Subscribe at AdafruitDaily.com !



No Comments

No comments yet.

Sorry, the comment form is closed at this time.