flutter_rb 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2085d887e060a00177dfef11e0a1219b7fa146064c315c409cf30ceccea494b
-  data.tar.gz: 7bbba89d78ed94e75e95f43180ae4f59449a04019b47f81e01e697174c482121
+  metadata.gz: 8564b7cdf9819a28ea1ca5c145f9dcb813556575998924fb9b6cc8db5224ca77
+  data.tar.gz: 51b4cc3dd7dbf3b0d0e7a653f29defc47293b685c3de05f6e5a99ce846df9e41
 SHA512:
-  metadata.gz: 9545fa39016e347701d743ebca162d70cbc599271db993f406d6262b9d1e72c120def9c47bbc2a9a7e3b941c490437558f4ecb285830becf1f6904265bd35413
-  data.tar.gz: 0070f79ba964624b33ece2ea1db4b8e3b9035a46be64d7f1d6f8da75f1abe5fc3ec0d2cbddc52c35d3cb8ffb8f6935d553374aa7dbeb0c3ce8fd5d9656a8a7eb
+  metadata.gz: 7b595e1256a18e7f74d5d273054f7608dae0c3674bd0467db4108fb4ef7c8936248cd3daf610ac5e11242fe169d97085bd008fee98bb5dca2a2461a72a7f01cc
+  data.tar.gz: 7b12583d8fad4af058cde7c45e560141a9f74db75fe215f70b57ebe3a0584a7979471a7b68680f7ded6ebdd469cbf4421cfb4822e8d9af29d18fe08f2638fef1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jaman.smlnsk@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/COMMIT_CONVENTION.md

@@ -0,0 +1,58 @@
+# Commit Convention
+
+## How to work with a project
+
+### As a repository maintainer
+
+#### New update
+
+1. clone a project from a repository to local workspace;
+2. create a new branch for an update;
+3. complete the update;
+4. perform a Code Review;
+5. merge your branch with `master`;
+6. delete your branch.
+
+#### Notes
+
+1. always delete development branches;
+2. always push squashed commit to `master`.
+
+### As a contributor
+
+1. clone a project from a repository to local workspace;
+2. create a new branch for an update;
+3. complete the update;
+4. perform a Code Review;
+5. create a Pull Request to the original repository.
+
+## Branches
+
+### In projects using next types of branches
+
+* `master` - master branch. Contains a production version of the project. Don't push working changes to `master`!
+* `version` - branch for a specific version.
+* `issue` - branch for a specific issue.
+
+## Commit message structure
+
+### Template
+
+```text
+[DATE] [VERSION]: [MESSAGE]
+```
+
+### Example
+
+```text
+2019-05-12 v. 2.1.3: fixed bugs in History screen
+```
+
+#### Commit body sections order
+
+1. `added` - what was added in the commit;
+2. `closed` - what issues closed in the commit;
+3. `fixed` - what was fixed in the commit;
+4. `updated` - what was updated in the commit;
+5. `deleted` - what was deleted in the commit;
+6. `refactored` - what was refactored in the commit.

data/README.md

@@ -3,7 +3,7 @@
 # flutter_rb
 
 [![GitHubActions](https://github.com/flutter-rb/flutter-rb/workflows/Build/badge.svg)](https://github.com/flutter-rb/flutter-rb/actions?branch=master)
-[![Codebeat](https://codebeat.co/badges/9bb32e28-ca86-4cdc-ba66-bda7f989979a)](https://codebeat.co/projects/github-com-fartem-flutter-rb-master)
+[![Codebeat](https://codebeat.co/badges/9bb32e28-ca86-4cdc-ba66-bda7f989979a)](https://codebeat.co/projects/github-com-flutter-rb-flutter-rb-master)
 [![Gem Version](https://badge.fury.io/rb/flutter_rb.svg)](https://badge.fury.io/rb/flutter_rb)
 
 ## About
@@ -14,13 +14,13 @@ A tool for checking a Flutter plugin structure.
 
 #### Levels
 
-Each issue has a `level` parameter that describes his significate level.
+Each issue has a `level` parameter that describes its significant importance.
 
-| Level     | Description                                 |
-|-----------|---------------------------------------------|
-| `NORMAL`  | Issue was not found                         |
-| `WARNING` | Issue is not serious and cannot break build |
-| `ERROR`   | Issue is critical and can break build       |
+| Level     | Description                                  |
+|-----------|----------------------------------------------|
+| `NORMAL`  | Issue not found                              |
+| `WARNING` | Issue is not serious and can't break a build |
+| `ERROR`   | Issue is critical and can break a build      |
 
 #### Flutter
 
@@ -58,36 +58,29 @@ You should add [flutter-rb-gradle-plugin](https://github.com/flutter-rb/flutter-
 
 ### Download gem from RubyGems
 
-Install gem:
-
 ```shell
-gem install flutter_rb
+$ gem i flutter_rb
 ```
 
 Then run from a Flutter plugin's project folder:
 
 ```shell
-frb
+$ frb
 ```
 
 ### As local installed gem
 
-Build gem from sources:
-
-```shell
-gem build flutter_rb.gemspec
-```
-
-Install gem:
+Build and install gem from sources:
 
 ```shell
-gem i flutter_rb
+$ gem build flutter_rb.gemspec
+$ gem i flutter_rb
 ```
 
 Then run from a Flutter plugin's project folder:
 
 ```shell
-frb
+$ frb
 ```
 
 ### As local executable
@@ -95,7 +88,7 @@ frb
 Add `project_folder/bin` (where `project_folder` is path to project on your machine) to `PATH` variable in your environment. Then updated environment and run from a Flutter plugin's project folder:
 
 ```shell
-local_frb
+$ local_frb
 ```
 
 ### Arguments
@@ -131,10 +124,10 @@ Tool can make report in Checkstyle format. To enable this feature, pass `--check
 
 ## How to contribute
 
-Read [Commit Convention](https://github.com/fartem/repository-rules/blob/master/commit-convention/COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request. Then:
+Read [Commit Convention](./COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request. Then:
 
 ```shell
-bundle exec rake
+$ bundle exec rake
 ```
 
 If you don't see any error messages, submit your pull request.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutter_rb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-13 00:00:00.000000000 Z
+date: 2023-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -102,6 +102,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- CODE_OF_CONDUCT.md
+- COMMIT_CONVENTION.md
 - LICENSE
 - README.md
 - bin/frb