diff --git a/CHANGELOG.md b/CHANGELOG.md index 4951e99..ea669c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Dart Package Versioning](https://dart.dev/tools/pub ## [Unreleased] +### Added + +_'Contribute'_ section to README — [65](https://github.com/dartoos-dev/well_formed/issues/65). + ## [0.4.1] - 2021-12-15 ### Changed diff --git a/README.md b/README.md index 85a32b1..7524a25 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,7 @@ by a CI/CD pipeline with rigorous quality gates. - [Invalid Inputs](#invalid-inputs) - [Fields With Proper Values](#fields-with-proper-values) - [Left Out Properties](#left-out-properties) +- [Contribute](#contribute) - [References](#references) @@ -468,6 +469,22 @@ int? maxLines, int? minLines, ``` +## Contribute + +Contributors are welcome! + +1. Open an issue regarding an improvement, a bug you noticed, or ask to be + assigned to an existing one. +2. If the issue is confirmed, fork the repository, do the changes on a separate + branch and make a _Pull Request_. +3. After review and acceptance, the _Pull Request_ is merged and closed. + +Make sure the commands below **passes** before making a Pull Request. + +```shell + flutter analyze && flutter test +``` + ## References - [TextFormField](https://api.flutter.dev/flutter/material/TextFormField-class.html)