Merge pull request #9 from rydmike/next-release

Version 1.5.0

.github/workflows/deploy.yml

@@ -27,8 +27,8 @@ on:
     paths-ignore:
       - "**.md"
   release:
-    branches: [none]
-    types: [publish]
+    branches: [master]
+    types: [published]
 
 jobs:
   flutter_tests:

CHANGELOG.md

@@ -2,11 +2,19 @@
 
 All notable changes to the **FlexSeedScheme** (FSS) package are documented here.
 
+## 1.5.0
+
+**April 3, 2024**
+
+* **NEW**
+  * Exposed `Hct` and `ViewingConditions` from the underlying Material Color Utilities (MCU) library. They are exposed for convenience, you no longer have to add and import (MCU) to use them. 
+  * Add `CODE_OF_CONDUCT.md` and `CONTRIBUTING.md` files for guidance on contributing to the package.
+
 ## 1.4.0
 
 **July 2, 2023**
 
-* **NEW FEATURES** 
+* **NEW** 
   * Added support for new HCT tones used by updated Material3 color system, that were added during the first half of 2023 to the Material 3 color system specification. The added tones 4, 6, 12, 17, 22 are for new dark mode surfaces in revised Material 3 dark surface colors. Likewise, added tones 97, 96, 94, 92, 87 are for light mode surfaces in the updated Material 3 color system. For more information, see: https://m3.material.io/styles/color/the-color-system/color-roles.
     * The change and additions are none breaking. APIs that want and can use the extended tones can pass in an optional `paletteType` of `FlexPaletteType` and set it to `FlexPaletteType.extended`, by default its values `FlexPaletteType.common` resulting in the 15 tones `[0, 5, 10, 20, 30, 40, 50, 60, 70, 80, 90, 95, 98, 99, 100]` being produced as before.
     * The complete list of the 25 extended tones are `[0, 4, 5, 6, 10, 12, 17, 20, 22, 30, 40, 50, 60, 70, 80, 87, 90, 92, 94, 95, 96, 97, 98, 99, 100]`.

CODE_OF_CONDUCT.md

@@ -0,0 +1,25 @@
+# Code of Conduct for Contributors
+
+We are committed to creating a friendly and respectful community for everyone who wants to contribute to this open source library. By participating in this project, you agree to abide by the following code of conduct.
+
+## Be respectful and constructive
+
+We value your feedback and suggestions, but please be respectful and constructive when you communicate with other contributors, maintainers, and users. Avoid personal attacks, insults, trolling, harassment, or any other behavior that could make others feel unwelcome or uncomfortable. If you disagree with someone, try to understand their perspective and explain your reasoning in a polite and clear manner.
+
+## Follow the project guidelines
+
+We have some guidelines for how to contribute to this project, such as coding style enforced via lint rules, documentation, testing, and pull requests. Please follow these guidelines when you make your contributions. They are designed to ensure the quality and consistency of the codebase, as well as to facilitate the review process. If you are unsure about something, feel free to ask the maintainers or other contributors for help.
+
+## Acknowledge the work of others
+
+We appreciate your contributions, but we also expect you to acknowledge the work of others who have contributed to this project before you. Do not claim credit for something that is not your own, or plagiarize from other sources. If you use or modify code from other sources, make sure to give proper attribution and follow the license terms.
+
+## Be honest and transparent
+
+We expect you to be honest and transparent about your contributions. Do not submit code that you know is faulty, incomplete, or untested. Do not misrepresent the purpose or scope of your contribution. Do not hide any potential conflicts of interest or ulterior motives. If you encounter any problems or issues with your contribution, please report them promptly and openly.
+
+## Be open and inclusive
+
+We welcome contributions from anyone who shares our vision and values for this project. We do not discriminate based on age, gender, race, ethnicity, religion, sexual orientation, disability, or any other personal characteristics. We strive to create an inclusive and diverse community that fosters collaboration and innovation.
+
+Thank you for your contribution! 🙏

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing to FlexSeedScheme
+
+Thank you for your interest in contributing to **FlexSeedScheme**, a more flexible and powerful version of Flutter's ColorScheme.fromSeed. Use multiple seed colors, custom chroma and tone mapping. We welcome contributions that fix bugs, introduce enhancements or new features, and correct API documentation errors or typos.
+
+## How to contribute
+
+Before you start working on your contribution, please follow these steps:
+
+- Fork the repository on GitHub and clone your fork to your local machine.
+- Create a new branch from the main branch and name it according to the type and scope of your contribution. For example, `fix/issue-123` or `feature/new-color-option`.
+- Make your changes in the new branch, following the code style and conventions of the project.
+- Write tests for your changes, using the existing test framework. Make sure your changes do not break any existing tests or decrease the test coverage of the project.
+- Commit your changes with a clear and descriptive message, referencing any relevant issues or pull requests.
+- Push your changes to your fork on GitHub and create a pull request against the main branch of the original repository.
+- Wait for the maintainers to review your pull request and provide feedback or approval.
+
+## What to contribute
+
+We appreciate any contribution that improves the quality and functionality of the package. Here are some examples of what you can contribute:
+
+- Bug fixes: If you find a bug in the package, please report it as an issue on GitHub and provide a fix if possible.
+- Enhancements: If you have an idea for a new feature or an improvement to an existing feature, please create an issue on GitHub to discuss it with the maintainers before working on it.
+- Documentation: If you notice any errors or typos in the API documentation or the README file, please correct them and submit a pull request.
+
+## What not to contribute
+
+We value your time and effort, but we also have some guidelines for what kind of contributions we do not accept. Please do not submit contributions that:
+
+- Introduce breaking API changes **without** prior discussion and approval from the maintainers.
+- Add little or no value to the package, such as stylistic or irrelevant updates in the samples that demonstrate usage of the package. Such contributions are unlikely to be merged, as they may cause unnecessary conflicts or maintenance issues.
+- Violate the code of conduct or the license of the project.
+
+## Code of conduct
+
+We expect all contributors to follow our code of conduct, which promotes a respectful and inclusive contribution community.
+
+## License
+
+By contributing to flex_seed_scheme, you agree that your contributions will be licensed under its [BSD 3-Clause License](https://github.com/rydmike/flex_seed_scheme/blob/master/LICENSE).
+
+Thank you for your contribution! 🙏

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-FlexSeedScheme Copyright (c) 2022
+FlexSeedScheme Copyright (c) 2022-2024
 Mike Rydstrom (Twitter @RydMike GitHub rydmike)
 All rights reserved.
 

all_lint_rules.yaml

@@ -1,6 +1,16 @@
-# A list of all linter rules. Up to date auto generated list of all
-# lint rules can be found here:
-# https://dart-lang.github.io/linter/lints/options/options.html
+# A list of all linter rules.
+#
+# Up-to-date auto generated list: https://dart.dev/tools/linter-rules/all
+#
+# The list below has removed ALL deprecated lint rules. These following were still included
+# in the above list of all lint rules, but are deprecated and should NOT be used:
+#
+# - avoid_returning_null_for_future (Deprecated)
+# - iterable_contains_unrelated_type (Deprecated)
+# - list_remove_unrelated_type (Deprecated)
+# - always_require_non_null_named_parameters (Deprecated)
+# - avoid_returning_null (Deprecated)
+#
 linter:
   rules:
     - always_declare_return_types
@@ -9,6 +19,7 @@ linter:
     - always_specify_types
     - always_use_package_imports
     - annotate_overrides
+    - annotate_redeclares
     - avoid_annotating_with_dynamic
     - avoid_bool_literals_in_conditional_expressions
     - avoid_catches_without_on_clauses
@@ -44,6 +55,7 @@ linter:
     - avoid_types_as_parameter_names
     - avoid_types_on_closure_parameters
     - avoid_unnecessary_containers
+    - avoid_unstable_final_fields
     - avoid_unused_constructor_parameters
     - avoid_void_async
     - avoid_web_libraries_in_flutter
@@ -81,15 +93,13 @@ linter:
     - implicit_call_tearoffs
     - implicit_reopen
     - invalid_case_patterns
-    - iterable_contains_unrelated_type
     - join_return_with_assignment
     - leading_newlines_in_multiline_strings
     - library_annotations
     - library_names
     - library_prefixes
     - library_private_types_in_public_api
     - lines_longer_than_80_chars
-    - list_remove_unrelated_type
     - literal_only_boolean_expressions
     - matching_super_parameters
     - missing_whitespace_between_adjacent_strings
@@ -101,6 +111,8 @@ linter:
     - no_literal_bool_comparisons
     - no_logic_in_create_state
     - no_runtimeType_toString
+    - no_self_assignments
+    - no_wildcard_variable_uses
     - non_constant_identifier_names
     - noop_primitive_operations
     - null_check_on_nullable_type_parameter
@@ -177,7 +189,7 @@ linter:
     - unnecessary_const
     - unnecessary_constructor_name
     - unnecessary_final
-    - unnecessary_getters_setters
+    - unnecessary_getters_settersinvariant_booleans
     - unnecessary_lambdas
     - unnecessary_late
     - unnecessary_library_directive