From eb6e3716df007fa029041ecd9ed366952c35e94a Mon Sep 17 00:00:00 2001 From: Robert Kuykendall Date: Mon, 17 Feb 2020 08:29:27 -0500 Subject: [PATCH 1/2] Better PR template; move component libraries higher in readme --- .github/PULL_REQUEST_TEMPLATE.md | 7 +++++-- README.md | 26 ++++++++++++++------------ 2 files changed, 19 insertions(+), 14 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d3c2df7b..f1e7ad05 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,6 @@ -# Description +_( what is the feature, or what is it this is PR fixing? )_ -_(what is the feature or what is this PR fixing?)_ +- [ ] Title is human readable, as it will be included directly in `CHANGELOG.md` when we do a release +- [ ] If this is a new user-facing feature, documentation has been added to `API.md` +- [ ] Any `dist/` changes have not been committed. Tests run directly on the source code and all dist changes are + computed and committed during release. diff --git a/README.md b/README.md index 12600ee8..aca14e77 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,10 @@ [![Build status](https://travis-ci.org/formsy/formsy-react.svg?branch=master)](https://travis-ci.org/formsy/formsy-react) [![Coverage Status](https://coveralls.io/repos/github/formsy/formsy-react/badge.svg?branch=master)](https://coveralls.io/github/formsy/formsy-react?branch=master) [![Gzipped size](http://img.badgesize.io/https://unpkg.com/formsy-react?compression=gzip)](https://unpkg.com/formsy-react) -[![Gitter](https://badges.gitter.im/formsy/Lobby.svg)](https://gitter.im/formsy/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) +[![GitHub contributors](https://img.shields.io/github/contributors/formsy/formsy-react.svg)](https://github.com/formsy/formsy-react/contributors) +![Typescript Types included](https://badgen.net/npm/types/tslib) -A form input builder and validator for React. +A form input builder and validator for React.attachToFormattachToFormattachToFormattachToForm | [Quick Start](#quick-start) | [API](/API.md) | [1.x API](https://github.com/formsy/formsy-react/blob/v1.x/API.md) | | --------------------------- | -------------- | ------------------------------------------------------------------ | @@ -16,13 +17,13 @@ A form input builder and validator for React. [christianalfoni](https://github.com/christianalfoni/) wrote an article on forms and validation with React, [Nailing that validation with React JS](http://christianalfoni.github.io/javascript/2014/10/22/nailing-that-validation-with-reactjs.html), -the result of that was this component. +the result of that was this library. The main concept is that forms, inputs, and validation are done very differently across developers and projects. This React component aims to be that “sweet spot” between flexibility and reusability. -This project was originally located at https://github.com/christianalfoni/formsy-react if you're looking for v0.x or old -issues. +This project was originally located at [christianalfoni/formsy-react](https://github.com/christianalfoni/formsy-react) +if you're looking for old issues. ## What You Can Do @@ -37,6 +38,14 @@ issues. `yarn add formsy-react react react-dom` and use with webpack, browserify, etc. +## Formsy component packages + +- [twisty/formsy-react-components](https://github.com/twisty/formsy-react-components) - Bootstrap components for a + formsy-react form.\ +- [zabute/formsy-semantic-ui-react](https://github.com/zabute/formsy-semantic-ui-react) - Formsy-React wrappers for + Semantic-Ui-React's form components + ([currently being updated to formsy 2.x](https://github.com/zabute/formsy-semantic-ui-react/pull/77)) + ## 1.x to 2.x Upgrade Guide The 2.0 release fixed a number of legacy decisions in the Formsy API, mostly a reliance on function props over value @@ -144,13 +153,6 @@ This code results in a form with a submit button that will run the `submit` meth valid email. The submit button is disabled as long as the input is empty ([required](/API.md#required)) and the value is not an email ([isEmail](/API.md#validators)). On validation error it will show the message: "This is not a valid email". -## Formsy component packages - -- https://github.com/twisty/formsy-react-components, Bootstrap 3 compatible form fields -- https://github.com/zabute/formsy-semantic-ui-react, Semantic UI form fields (out of date, for formsy-react 1.x) -- https://github.com/gogoair/react-formsy-combo-select, wrapper for https://github.com/gogoair/react-combo-select (out - of date, for formsy-react 1.x) - ## Contribute - Fork repo From 22eddc79f37a6581a809828236149516dacb37d2 Mon Sep 17 00:00:00 2001 From: Robert Kuykendall Date: Mon, 17 Feb 2020 08:33:03 -0500 Subject: [PATCH 2/2] Self-CR --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aca14e77..bfe328a0 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![GitHub contributors](https://img.shields.io/github/contributors/formsy/formsy-react.svg)](https://github.com/formsy/formsy-react/contributors) ![Typescript Types included](https://badgen.net/npm/types/tslib) -A form input builder and validator for React.attachToFormattachToFormattachToFormattachToForm +A form input builder and validator for React. | [Quick Start](#quick-start) | [API](/API.md) | [1.x API](https://github.com/formsy/formsy-react/blob/v1.x/API.md) | | --------------------------- | -------------- | ------------------------------------------------------------------ |