Create CONTRIBUTING.md #4715
Merged
Create CONTRIBUTING.md #4715
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
heath-freenome
approved these changes
Aug 12, 2025
heath-freenome
approved these changes
Aug 12, 2025
|
@Raj-G07 Thanks for adding this. I've made some small improvements to the file |
|
@heath-freenome |
|
@Raj-G07 You are most welcome |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Scope of Contributions
We welcome contributions in the following areas:
Tech Stack & Tools
Guiding Principles