Update CONTRIBUTING.md
This commit is contained in:
Salvatore Giordano
+139
-32
@@ -22,7 +22,7 @@ You can include the output of `flutter doctor --verbose` when filing an issue.
|
|||||||
|
|
||||||
Stream's Flutter code is kept in a single mono-repository consisting of multiple packages. Source code for each package can be found under the top-level `/packages` directory.
|
Stream's Flutter code is kept in a single mono-repository consisting of multiple packages. Source code for each package can be found under the top-level `/packages` directory.
|
||||||
|
|
||||||
|
<img width="1436" alt="Screen_Shot_2021-03-31_at_4 13 52_PM" src="https://user-images.githubusercontent.com/20601437/124240912-8791a080-db1b-11eb-9467-b00e9d14b1ca.png">
|
||||||
|
|
||||||
### Project Structure 🧱
|
### Project Structure 🧱
|
||||||
|
|
||||||
@@ -88,11 +88,11 @@ Before filing bugs, take a look at our existing backlog. For common bugs, there
|
|||||||
|
|
||||||
To quickly narrow down the amount of tickets on Github, try filtering based on the label that best suites the bug.
|
To quickly narrow down the amount of tickets on Github, try filtering based on the label that best suites the bug.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Didn't find an existing issue? Go ahead and file a new bug using one of our pre-made issue templates.
|
Didn't find an existing issue? Go ahead and file a new bug using one of our pre-made issue templates.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Be sure to provide as much information as possible when filing bug reports. A good issue should have steps to reproduce and information on your development environment and expected behavior.
|
Be sure to provide as much information as possible when filing bug reports. A good issue should have steps to reproduce and information on your development environment and expected behavior.
|
||||||
|
|
||||||
@@ -108,7 +108,7 @@ To file a feature request, select the "Discussions" tab on our GitHub repo or [v
|
|||||||
|
|
||||||
Screenshots, sketches, and sample code are all welcomed!
|
Screenshots, sketches, and sample code are all welcomed!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Here are some common questions to answer when filing a feature request:
|
Here are some common questions to answer when filing a feature request:
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ Add any other context or screenshots about the feature request here.
|
|||||||
|
|
||||||
## Pull Request 🎉
|
## Pull Request 🎉
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Thank you for taking the time to submit a patch and contribute to our codebase. You rock!
|
Thank you for taking the time to submit a patch and contribute to our codebase. You rock!
|
||||||
|
|
||||||
@@ -177,52 +177,159 @@ Develop is merged into master after the team performs various automated and QA t
|
|||||||
|
|
||||||
# Styleguides 💅
|
# Styleguides 💅
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
We use style guides and lint checks to keep our code consistent and maintain best practices. Our team uses Dart's built-in analyzer for linting and enforcing code styles. The full list of analyzer rules can be found below.
|
We use style guides and lint checks to keep our code consistent and maintain best practices. Our team uses Dart's built-in analyzer for linting and enforcing code styles. The full list of analyzer rules can be found below.
|
||||||
|
|
||||||
## Dart lint rules 📖
|
## Dart lint rules 📖
|
||||||
|
|
||||||
```jsx
|
```yaml
|
||||||
include: package:pedantic/analysis_options.yaml
|
|
||||||
|
|
||||||
analyzer:
|
analyzer:
|
||||||
enable-experiment:
|
|
||||||
- extension-methods
|
|
||||||
exclude:
|
exclude:
|
||||||
- lib/**/*.g.dart
|
- packages/*/lib/**/*.g.dart
|
||||||
- example/**
|
- packages/*/example/**
|
||||||
|
- packages/*/lib/src/emoji
|
||||||
|
- packages/*/lib/**/*.freezed.dart
|
||||||
|
- packages/*/test/**
|
||||||
|
|
||||||
linter:
|
linter:
|
||||||
rules:
|
rules:
|
||||||
|
# these rules are documented on and in the same order as
|
||||||
|
# the Dart Lint rules page to make maintenance easier
|
||||||
|
# https://github.com/dart-lang/linter/blob/master/example/all.yaml
|
||||||
|
- always_use_package_imports
|
||||||
- avoid_empty_else
|
- avoid_empty_else
|
||||||
- avoid_init_to_null
|
- avoid_relative_lib_imports
|
||||||
- avoid_return_types_on_setters
|
- avoid_slow_async_io
|
||||||
- avoid_web_libraries_in_flutter
|
- avoid_types_as_parameter_names
|
||||||
- await_only_futures
|
|
||||||
- camel_case_types
|
|
||||||
- cancel_subscriptions
|
- cancel_subscriptions
|
||||||
- close_sinks
|
- close_sinks
|
||||||
- control_flow_in_finally
|
- control_flow_in_finally
|
||||||
- empty_constructor_bodies
|
|
||||||
- empty_statements
|
- empty_statements
|
||||||
- hash_and_equals
|
- hash_and_equals
|
||||||
- implementation_imports
|
- invariant_booleans
|
||||||
- library_names
|
- iterable_contains_unrelated_type
|
||||||
- non_constant_identifier_names
|
- list_remove_unrelated_type
|
||||||
- package_names
|
- literal_only_boolean_expressions
|
||||||
- package_prefixed_library_names
|
- no_adjacent_strings_in_list
|
||||||
- prefer_is_not_empty
|
- no_duplicate_case_values
|
||||||
- public_member_api_docs
|
- no_logic_in_create_state
|
||||||
- slash_for_doc_comments
|
- prefer_void_to_null
|
||||||
- sort_constructors_first
|
|
||||||
- sort_unnamed_constructors_first
|
|
||||||
- test_types_in_equals
|
- test_types_in_equals
|
||||||
- throw_in_finally
|
- throw_in_finally
|
||||||
- type_init_formals
|
|
||||||
- unnecessary_brace_in_string_interps
|
|
||||||
- unnecessary_getters_setters
|
|
||||||
- unnecessary_statements
|
- unnecessary_statements
|
||||||
- unrelated_type_equality_checks
|
- unrelated_type_equality_checks
|
||||||
|
- omit_local_variable_types
|
||||||
|
- use_key_in_widget_constructors
|
||||||
- valid_regexps
|
- valid_regexps
|
||||||
|
- always_declare_return_types
|
||||||
|
- always_require_non_null_named_parameters
|
||||||
|
- annotate_overrides
|
||||||
|
- avoid_bool_literals_in_conditional_expressions
|
||||||
|
- avoid_catching_errors
|
||||||
|
- avoid_init_to_null
|
||||||
|
- avoid_null_checks_in_equality_operators
|
||||||
|
- avoid_positional_boolean_parameters
|
||||||
|
- avoid_private_typedef_functions
|
||||||
|
- avoid_redundant_argument_values
|
||||||
|
- avoid_return_types_on_setters
|
||||||
|
- avoid_returning_null_for_void
|
||||||
|
- avoid_shadowing_type_parameters
|
||||||
|
- avoid_single_cascade_in_expression_statements
|
||||||
|
- avoid_unnecessary_containers
|
||||||
|
- avoid_unused_constructor_parameters
|
||||||
|
- await_only_futures
|
||||||
|
- camel_case_extensions
|
||||||
|
- camel_case_types
|
||||||
|
- cascade_invocations
|
||||||
|
|
||||||
|
- constant_identifier_names
|
||||||
|
- curly_braces_in_flow_control_structures
|
||||||
|
- directives_ordering
|
||||||
|
- empty_catches
|
||||||
|
- empty_constructor_bodies
|
||||||
|
- exhaustive_cases
|
||||||
|
- file_names
|
||||||
|
- implementation_imports
|
||||||
|
- join_return_with_assignment
|
||||||
|
- leading_newlines_in_multiline_strings
|
||||||
|
- library_names
|
||||||
|
- library_prefixes
|
||||||
|
- lines_longer_than_80_chars
|
||||||
|
- missing_whitespace_between_adjacent_strings
|
||||||
|
- non_constant_identifier_names
|
||||||
|
- null_closures
|
||||||
|
- one_member_abstracts
|
||||||
|
- only_throw_errors
|
||||||
|
- package_api_docs
|
||||||
|
- package_prefixed_library_names
|
||||||
|
- parameter_assignments
|
||||||
|
- prefer_adjacent_string_concatenation
|
||||||
|
- prefer_asserts_in_initializer_lists
|
||||||
|
- prefer_asserts_with_message
|
||||||
|
- prefer_collection_literals
|
||||||
|
- prefer_conditional_assignment
|
||||||
|
- prefer_const_constructors
|
||||||
|
- prefer_const_constructors_in_immutables
|
||||||
|
- prefer_const_declarations
|
||||||
|
- prefer_const_literals_to_create_immutables
|
||||||
|
- prefer_constructors_over_static_methods
|
||||||
|
- prefer_contains
|
||||||
|
- prefer_equal_for_default_values
|
||||||
|
- prefer_expression_function_bodies
|
||||||
|
- prefer_final_fields
|
||||||
|
- prefer_final_in_for_each
|
||||||
|
- prefer_final_locals
|
||||||
|
- prefer_function_declarations_over_variables
|
||||||
|
- prefer_generic_function_type_aliases
|
||||||
|
- prefer_if_elements_to_conditional_expressions
|
||||||
|
- prefer_if_null_operators
|
||||||
|
- prefer_initializing_formals
|
||||||
|
- prefer_inlined_adds
|
||||||
|
- prefer_int_literals
|
||||||
|
- prefer_interpolation_to_compose_strings
|
||||||
|
- prefer_is_empty
|
||||||
|
- prefer_is_not_empty
|
||||||
|
- prefer_is_not_operator
|
||||||
|
- prefer_null_aware_operators
|
||||||
|
- prefer_single_quotes
|
||||||
|
- prefer_spread_collections
|
||||||
|
- prefer_typing_uninitialized_variables
|
||||||
|
- provide_deprecation_message
|
||||||
|
- public_member_api_docs
|
||||||
|
- recursive_getters
|
||||||
|
- sized_box_for_whitespace
|
||||||
|
- slash_for_doc_comments
|
||||||
|
- sort_child_properties_last
|
||||||
|
- sort_constructors_first
|
||||||
|
- sort_unnamed_constructors_first
|
||||||
|
|
||||||
|
- type_annotate_public_apis
|
||||||
|
- type_init_formals
|
||||||
|
- unnecessary_await_in_return
|
||||||
|
- unnecessary_brace_in_string_interps
|
||||||
|
- unnecessary_const
|
||||||
|
- unnecessary_getters_setters
|
||||||
|
- unnecessary_lambdas
|
||||||
|
- unnecessary_new
|
||||||
|
- unnecessary_null_aware_assignments
|
||||||
|
- unnecessary_null_in_if_null_operators
|
||||||
|
- unnecessary_nullable_for_final_variable_declarations
|
||||||
|
- unnecessary_parenthesis
|
||||||
|
- unnecessary_raw_strings
|
||||||
|
- unnecessary_string_escapes
|
||||||
|
- unnecessary_string_interpolations
|
||||||
|
- unnecessary_this
|
||||||
|
- use_is_even_rather_than_modulo
|
||||||
|
- use_late_for_private_fields_and_variables
|
||||||
|
- use_rethrow_when_possible
|
||||||
|
- use_setters_to_change_properties
|
||||||
|
- use_to_and_as_if_applicable
|
||||||
|
- package_names
|
||||||
|
- sort_pub_dependencies
|
||||||
|
|
||||||
|
- cast_nullable_to_non_nullable
|
||||||
|
- unnecessary_null_checks
|
||||||
|
- tighten_type_of_initializing_formals
|
||||||
|
- null_check_on_nullable_type_parameter
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user