diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..13b65015 --- /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(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 + +### 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. diff --git a/README.md b/README.md index c589addf..e6d8df7f 100644 --- a/README.md +++ b/README.md @@ -74,12 +74,12 @@ go get github.com/json-iterator/go # Contribution Welcomed ! -Contributors +Please see [out contributing guidelines](CONTRIBUTING.md) to help us improve this library! -- [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) +# Contributors -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) +Thanks to all the people who already contributed! + + + +