diff --git a/README.md b/README.md index a12acec8..fb1ce4a8 100644 --- a/README.md +++ b/README.md @@ -36,23 +36,23 @@ -* [About](#about) -* [Contribution](#contribution) - + [Prerequisite](#prerequisite) - + [Create a new package](#create-a-new-package) +- [About](#about) +- [Usage](#usage) +- [Contribution](#contribution) + - [Prerequisite](#prerequisite) + - [Create a new package](#create-a-new-package) - [Naming](#naming) - + [Create issues](#create-issues) - + [Branches](#branches) - + [Commits](#commits) + - [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) + - [Merge your work](#merge-your-work) + - [Update version.](#update-version) + - [Publish your package](#publish-your-package) + - [Badging](#badging) +- [Simple work flow diagramm](#simple-work-flow-diagramm) +- [Status](#status) +- [License](#license) @@ -68,6 +68,21 @@ Those packages are developed by [Wyatt Studio](https://wyatt-studio.fr) and are --- +## Usage + +You can add any package of the `packages/` sub directory in your project. + +```yaml +dependencies: + wyatt_analysis: + hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/ + version: ^2.4.1 +``` + +> You can also use the `git` protocol. But it's not recommended since it's not handle version constraints. + +--- + ## Contribution Clone this repo. @@ -109,12 +124,17 @@ 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_template --package_name --description A new Wyatt package --flutter false +mason upgrade +mason make wyatt_package_template \ + --package_name \ + --description A new Wyatt package \ + --flutter false + -o packages/ ``` > Browse our [bricks](https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-bricks) for more information. -The variable in the above command is important and must be clear and understandable. +The `` variable in the above command is important and must be clear and understandable. (see [Naming](#naming)) After creating the package, bootstrap the project with the `melos bs` command. @@ -129,7 +149,7 @@ It have to be clear and intelligible. For example, if the name is `CRUD BLOC` the following naming conventions should be used: 1. package name: `wyatt_crud_bloc` -2. example name: `example` +2. example name: `wyatt_crud_bloc_example` ### Create issues @@ -141,7 +161,9 @@ For example, if you want to work on the `i18n` package, you should create an iss 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: - `scope/type/short-name` +```text +scope/type/short-name +``` 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` . @@ -172,9 +194,9 @@ Some examples : * `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 (closes #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 +```text feat(auth): add AWS support. (closes #31) ``` @@ -262,22 +284,7 @@ or ``` -> Some packages requires Flutter, so please specify it. - ---- - -## Usage - -You can add any package of the `packages/` sub directory in your project. - -```yaml -dependencies: - wyatt_analysis: - hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/ - version: ^2.4.1 -``` - -> You can also use the `git` protocol. But it's not recommended since it's not handle version constraints. +> **Warning** Some packages requires Flutter, so please specify it. --- diff --git a/mason-lock.json b/mason-lock.json index 83cb506c..af1b8db1 100644 --- a/mason-lock.json +++ b/mason-lock.json @@ -1 +1 @@ -{"bricks":{"wyatt_component_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_component_template","ref":"7cea909470ce75b91840f479649b93f953ded596"}}}} \ No newline at end of file +{"bricks":{"wyatt_component_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_component_template","ref":"0d2605717add29556b12ad1145e4457d71f18c18"}},"wyatt_package_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_package_template","ref":"0d2605717add29556b12ad1145e4457d71f18c18"}}}} \ No newline at end of file diff --git a/resources/wyatt-studio-logo.png b/resources/wyatt-studio-logo.png index 322633e8..8292626e 100644 Binary files a/resources/wyatt-studio-logo.png and b/resources/wyatt-studio-logo.png differ