Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 1.85 KB
Raw

Contributing to json-test

Thank you for your interest in contributing to json-test! This document provides guidelines and information about contributing to this project.

How to Contribute

Bug Reports

Please file bug reports on the GitHub issue tracker. When filing a bug report, please include:

  • A clear description of the problem
  • Minimal steps to reproduce the issue
  • What you expected to happen
  • What actually happened
  • Version of json-test you're using

Feature Requests

Feature requests are welcome! Please submit them on the issue tracker and:

  • Describe the feature you'd like to see
  • Explain why this feature would be useful
  • Be aware that features should fit within the scope of the library

Pull Requests

We appreciate pull requests! To contribute code:

  1. Fork the repository and create a new branch
  2. Write your changes, including tests
  3. Update documentation as needed
  4. Ensure all tests pass with cargo test
  5. Submit a pull request

Pull Request Guidelines

  • Add tests for any new functionality
  • Update documentation as needed
  • Clearly describe your changes in the PR description

Testing

  • Write relevant tests for all new functionality
  • Ensure existing tests pass
  • Include both positive and negative test cases
  • Test edge cases

Documentation

  • Update documentation for any changed functionality
  • Include examples in documentation
  • Keep documentation clear and concise
  • Check that documentation builds without warnings

Release Process

The maintainers will handle releases. The process includes:

  1. Updating version numbers
  2. Updating CHANGELOG.md
  3. Creating git tags
  4. Publishing to crates.io

Getting Help

If you need help with your contribution:

  • Open a GitHub issue with your question
  • Tag it with "question" or "help wanted"
  • Be patient and respectful

Thank you for contributing to json-test!