You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+47Lines changed: 47 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -158,3 +158,50 @@ More [examples](https://github.com/Tencent/rapidjson/tree/master/example) are av
158
158
*[parsebyparts](https://github.com/Tencent/rapidjson/blob/master/example/parsebyparts/parsebyparts.cpp): Implements an `AsyncDocumentParser` which can parse JSON in parts, using C++11 thread.
159
159
*[filterkey](https://github.com/Tencent/rapidjson/blob/master/example/filterkey/filterkey.cpp): A command line tool to remove all values with user-specified key.
160
160
*[filterkeydom](https://github.com/Tencent/rapidjson/blob/master/example/filterkeydom/filterkeydom.cpp): Same tool as above, but it demonstrates how to use a generator to populate a `Document`.
161
+
162
+
## Contributing
163
+
164
+
RapidJSON welcomes contributions. When contributing, please follow the code below.
165
+
166
+
### Issues
167
+
168
+
Feel free to submit issues and enhancement requests.
169
+
170
+
Please help us by providing **minimal reproducible examples**, because source code is easier to let other people understand what happens.
171
+
For crash problems on certain platforms, please bring stack dump content with the detail of the OS, compiler, etc.
172
+
173
+
Please try breakpoint debugging first, tell us what you found, see if we can start exploring based on more information been prepared.
174
+
175
+
### Workflow
176
+
177
+
In general, we follow the "fork-and-pull" Git workflow.
178
+
179
+
1.**Fork** the repo on GitHub
180
+
2.**Clone** the project to your own machine
181
+
3.**Checkout** a new branch on your fork, start developing on the branch
182
+
4.**Test** the change before commit, Make sure the changes pass all the tests, including `unittest` and `preftest`, please add test case for each new feature or bug-fix if needed.
183
+
5.**Commit** changes to your own branch
184
+
6.**Push** your work back up to your fork
185
+
7. Submit a **Pull request** so that we can review your changes
186
+
187
+
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
188
+
189
+
### Copyright and Licensing
190
+
191
+
You can copy and paste the license summary from below.
192
+
193
+
```
194
+
Tencent is pleased to support the open source community by making RapidJSON available.
195
+
196
+
Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.
197
+
198
+
Licensed under the MIT License (the "License"); you may not use this file except
199
+
in compliance with the License. You may obtain a copy of the License at
200
+
201
+
http://opensource.org/licenses/MIT
202
+
203
+
Unless required by applicable law or agreed to in writing, software distributed
204
+
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
205
+
CONDITIONS OF ANY KIND, either express or implied. See the License for the
206
+
specific language governing permissions and limitations under the License.
0 commit comments