Skip to content
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.

Latest commit

 

History

History
113 lines (81 loc) · 4.79 KB

CONTRIBUTING.md

File metadata and controls

113 lines (81 loc) · 4.79 KB
Raw

Yes, this is the same content as the How to contribute page on the wiki.

How to contribute

Any help given on this project is massively appreciated! ❤

Contributing can be done by writing docs and code, or simply by asking a question! If you find something questionable, then so will probably many others as well. If you find something not working as expected, telling us or publish a pull request that fixes it is the best way around this.

Before starting, please read the guidelines on the subject on which you wish to dig into before contributing to Newtonsoft.Json-for-Unity.

Table of content

Got a Question or Problem?

The Newtonsoft.Json-for-Unity wiki is a great place to start looking for information.

If you have questions about this package, Newtonsoft.Json-for-Unity, you can try out the help request issue template on this repo. GitHub issues are the optimal way to get in contact with the maintainers of this repository, and we're all happy to help.

If you have questions about how to use Json.NET, please read the Json.NET documentation or ask on Stack Overflow. There are thousands of Json.NET questions on Stack Overflow with the json.net tag.

See the below sections for reporting bugs and feature requests if that more suits your case.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help by submitting an issue to the GitHub Repository. Even better you can submit a Pull Request with a fix.

When submitting an issue please include the following information:

  • A description of the issue

  • The JSON, classes, and Json.NET code related to the issue

  • The exception message and stacktrace if an error was thrown

  • Version of the Newtonsoft.Json-for-Unity package you were using (ex: 12.0.101)

  • Version of the Unity Editor (ex: 2019.1.1f1)

  • Does your issue only appear on certain build targets? (ex: Windows Standalone, Android, WebGL, even the Editor?)

  • If possible, please include code that reproduces the issue. Dropbox or GitHub's Gist can be used to share large code samples, or you could submit a pull request with the issue reproduced in a new test.

  • When creating an issue use the Bug Report issue template.

The more information you include about the issue, the more likely it is to be fixed!

Want a Feature?

You can request a new feature by submitting an issue to the GitHub Repository.

Submitting a Pull Request

When submitting a pull request to the GitHub Repository make sure to do the following:

  • Check that new and updated code follows Newtonsoft.Json-for-Unity's existing code formatting and naming standard at the Code style wiki page.

  • Run Newtonsoft.Json-for-Unity's unit tests to ensure no existing functionality has been affected. See the Src/Newtonsoft.Json-for-Unity.Tests/README.md for more info.

  • Write new unit tests to test your changes. All features and fixed bugs must have tests to verify they work

Read GitHub Help for more details about creating pull requests.