Skip to content

Commit 048c847

Browse files
authored
Create CONTRIBUTING.md
Project Overview React JSONSchema Form (RJSF) is a React library for generating dynamic, schema-driven forms from JSON Schema definitions. It removes the need for repetitive form markup by automatically rendering form fields based on a given schema, while offering extensive customization options for layout, widgets, validation, and styling. Goals of the Project - Provide a developer-friendly way to create complex forms quickly. - Maintain consistent, accessible form UI with minimal configuration. - Keep the codebase modular, performant, and easy to maintain. - Ensure compatibility with widely adopted JSON Schema standards. Scope of Contributions We welcome contributions in the following areas: - **Bug Fixes:** Address reported issues to maintain stability and reliability. - **New Features:** Add capabilities aligned with the project’s vision and roadmap. - **Documentation Improvements:** Enhance clarity, add examples, and keep guides up-to-date. - **Performance Optimizations:** Improve rendering speed and schema parsing efficiency. - **Accessibility Enhancements:** Ensure compliance with accessibility best practices. Tech Stack & Tools - **React** for UI rendering. - **JSON Schema Draft-07** as the schema specification. - **Prettier** for code formatting. - **ESLint** for linting and style enforcement. - **Jest** for unit and snapshot testing. Guiding Principles - Avoid breaking changes unless part of a planned major release. - All new features must include tests and documentation updates. - Code should be clean, readable, and well-commented where needed. - Maintain consistent coding style and follow established patterns in the codebase.
1 parent 9c8079b commit 048c847

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Contributing to React-JSONSchema-Form
2+
*Welcome, and thank you for considering contributing!*<br>
3+
Whether you’re reporting bugs, suggesting enhancements or writing code your help is always appreciated.
4+
## 1. Code of Conduct
5+
Please abide by our [Code of Conduct](CODE_OF_CONDUCT.md) to maintain a welcoming, inclusive project environment.
6+
## 2. Getting Started
7+
This guide will help you understand how to contribute effectively to React-JSONSchema. [Contributor's guide](https://rjsf-team.github.io/react-jsonschema-form/docs/contributing)

0 commit comments

Comments
 (0)