Skip to content

Commit

Permalink
Initial Revision
Browse files Browse the repository at this point in the history
  • Loading branch information
RenaudDenis committed Nov 14, 2024
0 parents commit 020fdb1
Show file tree
Hide file tree
Showing 21 changed files with 2,995 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/target
.idea/
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2024-11-14

### Added

- Initial release with core JSON testing functionality
- JSONPath-based value extraction and validation
- Fluent assertion API
- Property existence and value validation
- String operations with regex support
- Numeric comparisons
- Array and object validation
- Custom matcher support
- Basic type checking
- Property matching system
- Clear error messages

[0.1.0]: https://github.com/tylium/json-test-rs/releases/tag/v0.1.0
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# 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!
Loading

0 comments on commit 020fdb1

Please sign in to comment.