Skip to content

Latest commit

 

History

History
45 lines (24 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

45 lines (24 loc) · 2.73 KB

Community Engagement

Questions, suggestions, corrections. All are welcome.

Channels for community engagement (where I'll be looking) include:

  • Issues
  • Slack (link in the README)
  • StackOverflow (tag with json-everything)

Submitting Issues

Please be sure that you've read the documentation and that you're using the library correctly. It sounds silly, but these kinds of issues are actually quite common.

For bugs, please submit minimal reproductions that demonstrate the problem you're reporting. Do not send me your production code and expect me to debug it for you. While testing can never cover every case, these libraries are very thoroughly tested using public suites supplemented by my own test cases. As such I'm very confident that the libraries adhere to their respective specifications.

Development

Requirements

These libraries run tests in .Net 6 and .Net 8, so you'll need those.

All of the projects are configured to use the latest C# version.

IDE

I use Visual Studio Community with Resharper, and I try to keep everything updated.

Jetbrains Rider (comes with the Resharper stuff built-in), VS Code with your favorite extensions, or any basic text editor with a command line would work just fine. You do you.

Code Style & Releases

Please feel free to add any code contributions using your own coding style. Trying to conform to someone else's style can be a headache and confusing, and I prefer working code over pretty code. I find it's easier for contributors if I make my own style adjustments after a contribution rather than forcing conformance to my preferences.

Deployments to Nuget and json-everything.net occur automatically upon merging with master, so I usually create a secondary branch where I can first make any adjustments, including updating package versions and release notes.

For these reasons, you can expect your PRs to be retargeted to a branch other than master.

What Needs Doing?

Anything in the issues with a help wanted label is something that could benefit from a volunteer or two.

Of primary focus is translating the resource file into additional languages for JsonSchema.Net.

Outside of this, PRs are welcome. For larger changes or changes to the API surface, it's preferred that there be some discussion in an issue before a PR is submitted, just to discuss the specifics of the change. Mainly, I don't want you to feel like you've wasted your time if changes are requested or the PR is ultimately closed unmerged.