Skip to content

Conversation

Copy link

Copilot AI commented Oct 15, 2025

Overview

This PR adds a prominent note to the README documenting that the syntax of radioactive-forms is inspired by Angular's FormBuilder. This helps users, especially those familiar with Angular, understand the design philosophy and recognize the familiar API pattern.

Changes

Added a blockquote note immediately after the project description in README.md:

Note: The syntax of this project is inspired by Angular's FormBuilder, providing a familiar and intuitive API for defining form structures with initial values and validators.

Rationale

The form definition syntax in radioactive-forms:

const { form } = useForm<Profile>({
  name: ['', [Validators.required]],
  email: ['', [Validators.required]],
  age: [18, []],
});

closely mirrors Angular's FormBuilder syntax:

this.formBuilder.group({
  name: ['', [Validators.required]],
  email: ['', [Validators.required]],
  age: [18, []]
});

This similarity is intentional and makes the library more intuitive for developers familiar with Angular. Documenting this inspiration helps users understand the API design and makes the library more discoverable for those searching for Angular-like form solutions in React.

Placement

The note is positioned at the very top of the README, right after the project title and description, ensuring maximum visibility for anyone reading the documentation. The blockquote formatting makes it visually distinct while remaining unobtrusive.

Testing

  • ✅ All existing tests pass (75/75)
  • ✅ Type checking succeeds
  • ✅ No code changes required (documentation only)
Original prompt

Update the README file in the radioactive-forms repository to include a note that the syntax of the project is inspired by Angular's FormBuilder. This change should be clearly visible in the documentation and should be appropriately placed for users to easily understand the inspiration behind the syntax.

This pull request was created as a result of the following prompt from Copilot chat.

Update the README file in the radioactive-forms repository to include a note that the syntax of the project is inspired by Angular's FormBuilder. This change should be clearly visible in the documentation and should be appropriately placed for users to easily understand the inspiration behind the syntax.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits October 15, 2025 23:13
Co-authored-by: Identityofsine <67929513+Identityofsine@users.noreply.github.com>
Co-authored-by: Identityofsine <67929513+Identityofsine@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README to mention Angular FormBuilder inspiration Add Angular FormBuilder inspiration note to README Oct 15, 2025
Copilot AI requested a review from Identityofsine October 15, 2025 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants