diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6cb9a14f..27e4c46b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,28 @@ -#Stack Overflow +# Stack Overflow **Stack Overflow** is a fantastic resource for programmers, with many active users who are usually able to answer questions much quicker than I can. [Follow this link](http://stackoverflow.com/questions/ask?tags=reachability%20swift) to ask your question on SO -#Raising an issue here +# Raising an issue here -###Has someone else raised the issue? +### Has someone else raised the issue? Check through currently open AND closed issues. If the issue has already been raised, please comment on the existing one. -###It doesn't work +### It doesn't work "It doesn't work" doesn't help anyone solve your problem. What doesn't work? + It didn't compile? + It crashed? + It didn't show the correct Reachability state? -###It won't compile +### It won't compile If it won't compile, what error messages are you seeing? Include the code that's at fault - a screen shot might help here. -###It crashed +### It crashed If it crashed, include a stack-trace, and the code that's in error. -###Other stuff +### Other stuff + What version of Reachability.Swift are you using? + How is it installed? Manually, CocoaPods, Carthage? + Does it occur on device or simulator? Which device?