Skip to content

Latest commit

 

History

History
27 lines (14 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

27 lines (14 loc) · 1.95 KB

How to contribute

Thank you for your interest in the sjson-cpp! All contributions that follow our guidelines below and abide by our code of conduct are welcome.

In this document you will find relevant reading material, what contributions we are looking for, and what we are not looking for.

Project contact email: [email protected]

Getting set up

See the readme file for details on how to generate project solutions, build, and run the unit tests. Every pull request should run with continuous integration on every platform we support and the unit tests will also execute as well.

The project uses GitHub issues to track bugs and feature requests.

Whether you create an issue or a pull request, I will do my best to comment or reply within 48 hours.

Contributions we are looking for

Several issues already have a help wanted label. Those tasks should be either reasonably simple or tasks that I do not think I will get the chance to get to very soon.

Feature requests are welcome providing that they fit within the project scope. For smaller features, you are welcome to create an issue with as much relevant information as you can. If it makes sense, I will prioritize it or add it to the backlog, and if I feel it is beyond the scope of the project, I will tell you why and close the issue. For larger topics, the best way to move forward is to reach out by email.

Contributions we are not looking for

A lot of older compilers do not properly support C++11 and there is no plan to support them. This also applies to platforms that are either not mainstream or that we cannot easily test with continuous integration. If you would like to support such an exotic environment, reach out by email first so we can discuss this.

If you aren't sure, don't be afraid to reach out by email!