From 5a7c73afe21a7db7942cf0a2c64c51682c13e897 Mon Sep 17 00:00:00 2001 From: NITHISH T <84063351+NithishNithi@users.noreply.github.com> Date: Fri, 15 Mar 2024 18:22:39 +0530 Subject: [PATCH 1/8] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c589addf..43147228 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,11 @@ go get github.com/json-iterator/go # Contribution Welcomed ! -Contributors +## Contributing + +Please see [out contributing guidelines](CONTRIBUTING.md) to help us improve this library! + +# Contributors - [thockin](https://github.com/thockin) - [mattn](https://github.com/mattn) From 1bb00647ba16eb51a7a7df283b63e571334a5042 Mon Sep 17 00:00:00 2001 From: NITHISH T <84063351+NithishNithi@users.noreply.github.com> Date: Fri, 15 Mar 2024 18:37:47 +0530 Subject: [PATCH 2/8] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 43147228..0eed7e15 100644 --- a/README.md +++ b/README.md @@ -74,8 +74,6 @@ go get github.com/json-iterator/go # Contribution Welcomed ! -## Contributing - Please see [out contributing guidelines](CONTRIBUTING.md) to help us improve this library! # Contributors From 464b54a9ca96af236d78185051df3901940f5242 Mon Sep 17 00:00:00 2001 From: NITHISH T <84063351+NithishNithi@users.noreply.github.com> Date: Fri, 15 Mar 2024 18:52:01 +0530 Subject: [PATCH 3/8] Create CONTRIBUTING.md --- CONTRIBUTING.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d26cf3ed --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,75 @@ +# Contributing + +## Introduction + +We appreciate your interest in considering contributing to go (json-iterator). +Community contributions mean a lot to us. + +## Contributions we need + +You may already know how you'd like to contribute, whether it's a fix for a bug you +encountered, or a new feature your team wants to use. + +If you don't know where to start, consider improving +documentation, bug triaging, and writing tutorials are all examples of +helpful contributions that mean less work for you. + +## Your First Contribution + +Unsure where to begin contributing? You can start by looking through +[help-wanted +issues](https://github.com/json-iterator/go/issues). + +Never contributed to open source before? Here are a couple of friendly +tutorials: + +- +- + +## Getting Started + +Here's how to get started with your code contribution: + +1. Create your own fork of go +2. Do the changes in your fork +3. If you like the change and think the project could use it, send a + pull request + +### Troubleshooting + +If you get any errors when running, make sure +that you are using supported versions of go. + +## How to Report a Bug + +### Security Vulnerabilities + +**NOTE**: If you find a security vulnerability, do NOT open an issue. +Email [go (mailto:taowen@gmail.com) instead. + + +### Everything Else + +When filing an issue, make sure to answer these four questions: + +1. What version of go(json-iterator) are you using? +2. What did you do? +3. What did you expect to see? +4 What did you see instead? + +## Suggest a feature or enhancement + +If you'd like to contribute a new feature, make sure you check our +issue list to see if someone has already proposed it. Work may already +be underway on the feature you want or we may have rejected a +feature like it already. + +If you don't see anything, open a new issue that describes the feature +you would like and how it should work. + +## Code review process + +The core team regularly looks at pull requests. We will provide +feedback as soon as possible. After receiving our feedback, please respond +within two weeks. After that time, we may close your PR if it isn't +showing any activity. From 387ce683ed58836b47db176a55ec44c831e489f5 Mon Sep 17 00:00:00 2001 From: NITHISH T <84063351+NithishNithi@users.noreply.github.com> Date: Fri, 15 Mar 2024 18:55:21 +0530 Subject: [PATCH 4/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d26cf3ed..de695158 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,7 +55,7 @@ When filing an issue, make sure to answer these four questions: 1. What version of go(json-iterator) are you using? 2. What did you do? 3. What did you expect to see? -4 What did you see instead? +4. What did you see instead? ## Suggest a feature or enhancement From 3ab2bed715b1d3d27cdd6cec8007ab93c2f8b24f Mon Sep 17 00:00:00 2001 From: NITHISH T <84063351+NithishNithi@users.noreply.github.com> Date: Fri, 15 Mar 2024 19:01:21 +0530 Subject: [PATCH 5/8] Update README.md --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0eed7e15..e6d8df7f 100644 --- a/README.md +++ b/README.md @@ -78,10 +78,8 @@ Please see [out contributing guidelines](CONTRIBUTING.md) to help us improve thi # Contributors -- [thockin](https://github.com/thockin) -- [mattn](https://github.com/mattn) -- [cch123](https://github.com/cch123) -- [Oleg Shaldybin](https://github.com/olegshaldybin) -- [Jason Toffaletti](https://github.com/toffaletti) +Thanks to all the people who already contributed! -Report issue or pull request, or email taowen@gmail.com, or [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/json-iterator/Lobby) + + + From 4ce008fb2083e447a6509950537d2641beff0bbf Mon Sep 17 00:00:00 2001 From: NITHISH T <84063351+NithishNithi@users.noreply.github.com> Date: Fri, 15 Mar 2024 19:05:03 +0530 Subject: [PATCH 6/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index de695158..13b65015 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ tutorials: Here's how to get started with your code contribution: -1. Create your own fork of go +1. Create your own fork of go(json-iterator/go) 2. Do the changes in your fork 3. If you like the change and think the project could use it, send a pull request From 3a263e450c9ec29687caa2701b01cc44a36d7e0c Mon Sep 17 00:00:00 2001 From: NITHISH T <84063351+NithishNithi@users.noreply.github.com> Date: Fri, 15 Mar 2024 19:06:07 +0530 Subject: [PATCH 7/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e6d8df7f..63d783cb 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ A high-performance 100% compatible drop-in replacement of "encoding/json" ![benchmark](http://jsoniter.com/benchmarks/go-benchmark.png) -Source code: https://github.com/json-iterator/go-benchmark/blob/master/src/github.com/json-iterator/go-benchmark/benchmark_medium_payload_test.go +Source code: [!Link](https://github.com/json-iterator/go-benchmark/blob/master/src/github.com/json-iterator/go-benchmark/benchmark_medium_payload_test.go) Raw Result (easyjson requires static code generation) From 0a5913ea0cf6c8aa347f1954146f5f36958f358c Mon Sep 17 00:00:00 2001 From: NITHISH T <84063351+NithishNithi@users.noreply.github.com> Date: Fri, 15 Mar 2024 19:08:34 +0530 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 63d783cb..e6d8df7f 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ A high-performance 100% compatible drop-in replacement of "encoding/json" ![benchmark](http://jsoniter.com/benchmarks/go-benchmark.png) -Source code: [!Link](https://github.com/json-iterator/go-benchmark/blob/master/src/github.com/json-iterator/go-benchmark/benchmark_medium_payload_test.go) +Source code: https://github.com/json-iterator/go-benchmark/blob/master/src/github.com/json-iterator/go-benchmark/benchmark_medium_payload_test.go Raw Result (easyjson requires static code generation)