docs: update readme
This commit is contained in:
parent
6f585cf7ee
commit
973eefa7bc
GPG Key ID:
3AAC487E131E00BC
176
README.md
176
README.md
@ -1,5 +1,5 @@
|
||||
<!--
|
||||
* Copyright (C) 2022 WYATT GROUP
|
||||
* Copyright (C) 2023 WYATT GROUP
|
||||
* Please see the AUTHORS file for details.
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
@ -7,7 +7,7 @@
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
@ -17,19 +17,13 @@
|
||||
-->
|
||||
|
||||
<p align="center">
|
||||
<a href="https://wyatt-studio.fr">
|
||||
<img width="150px" src="resources/wyatt-studio-logo.png">
|
||||
</a>
|
||||
<a href="https://wyatt-studio.fr"><img width="150px" src="resources/wyatt-studio-logo.png"></a>
|
||||
<h1 align="center">Wyatt Packages</h1>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis">
|
||||
<img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" />
|
||||
</a>
|
||||
<a href="https://github.com/invertase/melos">
|
||||
<img src="https://img.shields.io/badge/Maintained%20with-melos-f700ff.svg?style=flat-square" alt="Maintained with Melos" />
|
||||
</a>
|
||||
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis"><img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" /></a>
|
||||
<a href="https://github.com/invertase/melos"><img src="https://img.shields.io/badge/Maintained%20with-melos-f700ff.svg?style=flat-square" alt="Maintained with Melos" /></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
@ -38,12 +32,40 @@
|
||||
|
||||
---
|
||||
|
||||
<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
|
||||
|
||||
<!-- code_chunk_output -->
|
||||
|
||||
- [About](#about)
|
||||
- [Contribution](#contribution)
|
||||
- [Prerequisite](#prerequisite)
|
||||
- [Create a new package](#create-a-new-package)
|
||||
- [Naming](#naming)
|
||||
- [Create issues](#create-issues)
|
||||
- [Branches](#branches)
|
||||
- [Commits](#commits)
|
||||
- [Before pushing](#before-pushing)
|
||||
- [Merge your work](#merge-your-work)
|
||||
- [Update version.](#update-version)
|
||||
- [Publish your package](#publish-your-package)
|
||||
- [Badging](#badging)
|
||||
- [Usage](#usage)
|
||||
- [Simple work flow diagramm](#simple-work-flow-diagramm)
|
||||
- [Status](#status)
|
||||
- [License](#license)
|
||||
|
||||
<!-- /code_chunk_output -->
|
||||
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
Here is a set of [Flutter plugins](https://flutter.io/platform-plugins/) that enhance your applications.
|
||||
|
||||
[Flutter](https://flutter.dev) is Google's UI toolkit for building beautiful, natively compiled applications for mobile, web, and desktop using a single codebase. It is used by developers and organizations worldwide and is free and open-source.
|
||||
|
||||
Those packages are developed by [Wyatt Studio](https://wyatt-studio.fr) and are available exclusively on this repository.
|
||||
|
||||
---
|
||||
|
||||
## Contribution
|
||||
@ -77,9 +99,9 @@ dart pub global activate mason_cli
|
||||
brew install lcov
|
||||
```
|
||||
|
||||
- genhtml. Used to convert coverage data into html pages.
|
||||
* genhtml. Used to convert coverage data into html pages.
|
||||
|
||||
After installation of all these packages, the project can be bootstrapped using the command `melos bs`.
|
||||
After installation of all these packages, the project can be bootstrapped using the command `melos bs` .
|
||||
|
||||
### Create a new package
|
||||
|
||||
@ -87,9 +109,11 @@ Create a new package in `packages/` folder.
|
||||
To create a new package in the packages/ folder, run the following command in the terminal:
|
||||
|
||||
```shell
|
||||
mason make wyatt_package --package_name wyatt_<name> --description A new Wyatt package --flutter_only false
|
||||
mason make wyatt_package_template --package_name <name> --description A new Wyatt package --flutter false
|
||||
```
|
||||
|
||||
> Browse our [bricks](https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-bricks) for more information.
|
||||
|
||||
The <name> variable in the above command is important and must be clear and understandable.
|
||||
|
||||
After creating the package, bootstrap the project with the `melos bs` command.
|
||||
@ -101,70 +125,63 @@ It have to be clear and intelligible.
|
||||
|
||||
1. You must use underscores in the name.
|
||||
2. You must use the wyatt prefix for the package name.
|
||||
3. You must name the example with a specific name.
|
||||
|
||||
For example, if the name is "CRUD BLOC," the following naming conventions should be used:
|
||||
For example, if the name is `CRUD BLOC` the following naming conventions should be used:
|
||||
|
||||
1. name: crud_bloc
|
||||
2. package name: wyatt_crud_bloc
|
||||
3. example name: crud_bloc_example
|
||||
1. package name: `wyatt_crud_bloc`
|
||||
2. example name: `example`
|
||||
|
||||
### Create issues
|
||||
|
||||
Create an issue for each specific feature or task you want to work on and label it correctly using the following format:
|
||||
Create an issue for each specific feature or task you want to work on and label it correctly using the following labels: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/labels.
|
||||
|
||||
```
|
||||
Type(scope): issue.
|
||||
```
|
||||
|
||||
For example, on notification bloc package :
|
||||
|
||||
- `Feature(notification_bloc): add firebase messaging data source.`
|
||||
- `Test(notification_bloc): add test for pushwoosh datasource.`
|
||||
For example, if you want to work on the `i18n` package, you should create an issue with the `i18n` label.
|
||||
|
||||
### Branches
|
||||
|
||||
The master branch is protected and cannot be pushed to directly. Please create a separate branch for each feature or task, with a name that corresponds to the related issue. The branch name should follow this format:
|
||||
The `master` branch is protected and cannot be pushed to directly. Please create a separate branch for each feature or task, with a name that corresponds to the related issue. The branch name should follow this format:
|
||||
|
||||
`type(scope):issue`
|
||||
`scope/type/short-name`
|
||||
|
||||
Example :
|
||||
For the issue:
|
||||
|
||||
- `Feature(notification_bloc): add firebase messaging data source.`
|
||||
|
||||
The related branch should be named:
|
||||
|
||||
- `notification_bloc/feat/add_firebase_messaging_data_source`
|
||||
For example, if you are working on the `i18n` package and you want to add a new feature, you should create a branch named `i18n/feat/add-new-feature` .
|
||||
|
||||
### Commits
|
||||
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
tl;dr : `type(scope): description #issue`.
|
||||
tldr : `type(scope): description #issue` .
|
||||
|
||||
Here allowed <type> values:
|
||||
|
||||
- **feat** for a new feature for the user, not a new feature for build script. Such commit will trigger a release bumping a MINOR version.
|
||||
- **fix** for a bug fix for the user, not a fix to a build script. Such commit will trigger a release bumping a PATCH version.
|
||||
- **perf** for performance improvements. Such commit will trigger a release bumping a PATCH version.
|
||||
- **docs** for changes to the documentation.
|
||||
- **style** for formatting changes, missing semicolons, etc.
|
||||
- **refactor** for refactoring production code, e.g. renaming a variable.
|
||||
- **test** for adding missing tests, refactoring tests; no production code change.
|
||||
- **build** for updating build configuration, development tools or other changes irrelevant to the user.
|
||||
* **build** for updating build configuration, development tools or other changes irrelevant to the user.
|
||||
* **ci** for changes to our CI configuration files and scripts.
|
||||
* **docs** for changes to documentation.
|
||||
* **feat** for a new feature for the user, not a new feature for build script. Such commit will trigger a release bumping a MINOR version.
|
||||
* **fix** for a bug fix for the user, not a fix to a build script. Such commit will trigger a release bumping a PATCH version.
|
||||
* **perf** for performance improvements. Such commit will trigger a release bumping a PATCH version.
|
||||
* **refactor** for refactoring production code, e.g. renaming a variable.
|
||||
* **style** for formatting changes, missing semicolons, etc.
|
||||
* **test** for adding missing tests, refactoring tests; no production code change.
|
||||
* **chore** for updating grunt tasks etc; no production code change.
|
||||
|
||||
> Check `.pre-commit-config.yaml` and [pre-commit](https://pre-commit.com/) for more information about commit hooks.
|
||||
|
||||
Some examples :
|
||||
|
||||
- `feat(auth): add AWS support. (#31)` = add a feature in authentication_bloc package, linked to the 31st issue.
|
||||
- `docs: update readme.` = update **this** readme file.
|
||||
- `fix(crud)!: fix bug in awesome() function. (#32)` = fix a bug, `!` is important and indicate `BREAKING CHANGES` linked with the 32nd issue.
|
||||
* `feat(auth): add AWS support. (#31)` = add a feature in authentication_bloc package, linked to the 31st issue.
|
||||
* `docs: update readme.` = update **this** readme file.
|
||||
* `fix(crud)!: fix bug in awesome() function. (closes #32)` = fix a bug, `!` is important and indicate `BREAKING CHANGES` linked with the 32nd issue.
|
||||
|
||||
When you have completed your development work and are ready to resolve the related issue, you can close it via your commit message by including (close #issue_number). For example:
|
||||
When you have completed your development work and are ready to resolve the related issue, you can close it via your commit message by including (closes #issue_number). For example:
|
||||
|
||||
```shell
|
||||
feat(auth): add AWS support. (close #31)
|
||||
feat(auth): add AWS support. (closes #31)
|
||||
```
|
||||
|
||||
> You can use `close` , `closes` , `closed` , `fix` , `fixes` , `fixed` , `resolve` , `resolves` or `resolved` .
|
||||
|
||||
#### Before pushing
|
||||
|
||||
```shell
|
||||
melos run test:all # this will run all tests in this project
|
||||
melos run gen-coverage # this will generate coverage report
|
||||
@ -176,19 +193,19 @@ melos run publish # this will publish packages
|
||||
|
||||
Please note that the issue will only be closed after it has been merged into the master branch. Before closing the issue, it is important to verify that all tests have been run and that coverage has been updated.
|
||||
|
||||
#### Merge your work
|
||||
### Merge your work
|
||||
|
||||
When you have completed your work and closed the related issue, it's possible that some changes may have been made to the master branch in the meantime. To maintain a clean Git history, it's recommended to rebase before creating a change request (pull request).
|
||||
|
||||
Two situations :
|
||||
|
||||
- You haven't created a branch yet and have made local commits:
|
||||
* You haven't created a branch yet and have made local commits:
|
||||
|
||||
```shell
|
||||
git pull --rebase
|
||||
```
|
||||
|
||||
- You are already working on a branch:
|
||||
* You are already working on a branch:
|
||||
|
||||
```shell
|
||||
git rebase -i master
|
||||
@ -198,7 +215,7 @@ It's recommended to use the `--fixup` option during the interactive rebase to ke
|
||||
|
||||
Once you have rebased, you can create a pull request, receive the necessary approvals, and then merge your work. And with that, you're done! 🎉
|
||||
|
||||
#### Update version.
|
||||
### Update version.
|
||||
|
||||
When your work has been merged into the master branch, it's time to update the package version. To update only your specific package, use the --scope option. For example, after merging changes into the `wyatt_notification_bloc` package, you can run the following command:
|
||||
|
||||
@ -214,22 +231,24 @@ You can then verify that all packages and their tests are working correctly by r
|
||||
melos run test:all
|
||||
```
|
||||
|
||||
#### Publish your package
|
||||
### Publish your package
|
||||
|
||||
If package is ready for procution, publish it runnig :
|
||||
If package is ready for production, publish it by running the following command :
|
||||
|
||||
```shell
|
||||
melos publish --scope"*package*"
|
||||
```
|
||||
|
||||
#### Badging
|
||||
### Badging
|
||||
|
||||
In the package `readme.md` file, please specify the supported SDK:
|
||||
|
||||
|
||||
|
||||
```markdown
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
or
|
||||
@ -237,7 +256,9 @@ or
|
||||
|
||||
|
||||
```markdown
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
---
|
||||
@ -251,11 +272,20 @@ dependencies:
|
||||
wyatt_analysis:
|
||||
git:
|
||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||
ref: wyatt_analysis-v2.0.0
|
||||
ref: wyatt_analysis-v2.4.1
|
||||
path: packages/wyatt_analysis
|
||||
```
|
||||
|
||||
Here you can change `package name` and `package version`.
|
||||
or the hosted version :
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
wyatt_analysis:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: 2.4.1
|
||||
```
|
||||
|
||||
Here you can change `package name` and `package version` .
|
||||
|
||||
---
|
||||
|
||||
@ -263,10 +293,32 @@ Here you can change `package name` and `package version`.
|
||||
|
||||
To sum up, here a simple work flow diagramm.
|
||||
|
||||
|
||||
```plantuml
|
||||
@startuml Simple Developpment Workflow
|
||||
start
|
||||
:Create an issue;
|
||||
:Create branch related to the issue;
|
||||
repeat :Commit related to the issue;
|
||||
repeat while (feature is done)
|
||||
:Update coverage;
|
||||
:Close issue via last commit;
|
||||
:Rebase from `master`;
|
||||
:Create pull request;
|
||||
:Merge branches;
|
||||
:Update version;
|
||||
:Publish package;
|
||||
stop
|
||||
@enduml
|
||||
```
|
||||
|
||||
## Status
|
||||
|
||||
|
||||
|
||||
This repository is maintained by Wyatt Studio but work is in progress.
|
||||
|
||||
## License
|
||||
|
||||
[](http://www.gnu.org/licenses/gpl-3.0)
|
||||
|
||||
Thoses packages are licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
@startuml Simple Developpment Workflow
|
||||
start
|
||||
:Create an issue;
|
||||
:Create branch related to the issue;
|
||||
repeat :Commit related to the issue;
|
||||
repeat while (feature is done)
|
||||
:Update coverage;
|
||||
:Close issue via last commit;
|
||||
:Rebase from `master`;
|
||||
:Create pull request;
|
||||
:Merge branches;
|
||||
:Update version;
|
||||
:Publish package;
|
||||
stop
|
||||
@enduml
|
||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 7.5 KiB |
Loading…
x
Reference in New Issue
Block a user