Skip to content

Commit bc93092

Browse files
committed
* added some repo ground rules
1 parent 4c4c1d3 commit bc93092

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

Repo.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Since JSONModel is becoming more and more popular I need to set some ground rules.
2+
3+
Reporting an issue on GitHub
4+
====================================
5+
6+
------------------------------------
7+
<a href=“whattoreport”></a>
8+
#### What to report?
9+
10+
Be sure you are reporting either 1) a bug you have discovered or 2) a feature request.
11+
12+
People have been abusing the GitHub issues system for a while to ask all kind of vague questions and I’ve been helping some, but to be honest I just don’t have the time to clarify with the reporting what they need and try to find a solution for each and every case.
13+
14+
Long story short - make sure you are reporting something and not just asking how this or that is done.
15+
16+
<a href=“howtoreport”></a>
17+
#### How to report a problem/request a feature?
18+
19+
Describe what you expected to happen and what actually happened instead.
20+
21+
Add the piece of JSON relevant to the problem and your Objective-C model code.
22+
23+
I need to be able to **reproduce the problem** in order to fix it.
24+
25+
Of course the best would be if you already have fixed the problem yourself, then create a pull request. If you do - before you send a pull request run ALL TEST CASES on both IOS and OSX! Add a test case for what you have fixed, since it obviously haven’t been covered with one if there was a problem to be fixed.
26+
27+
<a href=“helpwithcode”></a>
28+
#### In case you need help with your code/models …
29+
30+
In case you **do need help** with your code: your best start is to **read the repo README**, many people don’t and it really is the best place to find many answers.
31+
32+
In case the README does not answer your question, try StackOverflow. There’s a **hashtag jsonmodel** - search the questions [answered so far](http://stackoverflow.com/questions/tagged/jsonmodel), and if you don’t find a solution create a new question and give it the tag **jsonmodel**.
33+

0 commit comments

Comments
 (0)