Compare commits

..

No commits in common. "1cadba5cd506e24be873966025772c2a5dc971c2" and "45458e7784f3da20796853b84739c220ff4dacc8" have entirely different histories.

5 changed files with 39 additions and 48 deletions

View File

@ -36,23 +36,23 @@
<!-- code_chunk_output --> <!-- code_chunk_output -->
- [About](#about) * [About](#about)
- [Usage](#usage) * [Contribution](#contribution)
- [Contribution](#contribution) + [Prerequisite](#prerequisite)
- [Prerequisite](#prerequisite) + [Create a new package](#create-a-new-package)
- [Create a new package](#create-a-new-package)
- [Naming](#naming) - [Naming](#naming)
- [Create issues](#create-issues) + [Create issues](#create-issues)
- [Branches](#branches) + [Branches](#branches)
- [Commits](#commits) + [Commits](#commits)
- [Before pushing](#before-pushing) - [Before pushing](#before-pushing)
- [Merge your work](#merge-your-work) + [Merge your work](#merge-your-work)
- [Update version.](#update-version) + [Update version.](#update-version)
- [Publish your package](#publish-your-package) + [Publish your package](#publish-your-package)
- [Badging](#badging) + [Badging](#badging)
- [Simple work flow diagramm](#simple-work-flow-diagramm) * [Usage](#usage)
- [Status](#status) * [Simple work flow diagramm](#simple-work-flow-diagramm)
- [License](#license) * [Status](#status)
* [License](#license)
<!-- /code_chunk_output --> <!-- /code_chunk_output -->
@ -68,21 +68,6 @@ 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 ## Contribution
Clone this repo. Clone this repo.
@ -124,17 +109,12 @@ Create a new package in `packages/` folder.
To create a new package in the packages/ folder, run the following command in the terminal: To create a new package in the packages/ folder, run the following command in the terminal:
```shell ```shell
mason upgrade mason make wyatt_package_template --package_name <name> --description A new Wyatt package --flutter false
mason make wyatt_package_template \
--package_name <name> \
--description A new Wyatt package \
--flutter false
-o packages/<name>
``` ```
> Browse our [bricks](https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-bricks) for more information. > 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. (see [Naming](#naming)) 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. After creating the package, bootstrap the project with the `melos bs` command.
@ -149,7 +129,7 @@ It have to be clear and intelligible.
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. package name: `wyatt_crud_bloc` 1. package name: `wyatt_crud_bloc`
2. example name: `wyatt_crud_bloc_example` 2. example name: `example`
### Create issues ### Create issues
@ -161,9 +141,7 @@ 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: 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:
```text `scope/type/short-name`
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` . 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` .
@ -194,9 +172,9 @@ Some examples :
* `docs: update readme.` = update **this** readme file. * `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. * `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:
```text ```shell
feat(auth): add AWS support. (closes #31) feat(auth): add AWS support. (closes #31)
``` ```
@ -284,7 +262,22 @@ or
``` ```
> **Warning** Some packages requires Flutter, so please specify it. > 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.
--- ---

View File

@ -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":"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"}}}} {"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"}}}}

View File

@ -16,7 +16,7 @@ command:
linkToCommits: false # Gitea not yet supported linkToCommits: false # Gitea not yet supported
workspaceChangelog: true workspaceChangelog: true
includeCommitId: false # Generate error in Melos 3... includeCommitId: false # Generate error in Melos 3...
# branch: master # Since we are using rebasing, we don't need to specify the branch branch: master
message: | message: |
chore(release): publish packages chore(release): publish packages

View File

@ -3,8 +3,6 @@ description: GoRouter Enhancements.
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_go_router repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_go_router
version: 1.0.0 version: 1.0.0
publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
environment: environment:
sdk: ">=3.0.0 <4.0.0" sdk: ">=3.0.0 <4.0.0"

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 11 KiB