Update readme #233
							
								
								
									
										81
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										81
									
								
								README.md
									
									
									
									
									
								
							| @ -36,23 +36,23 @@ | |||||||
| 
 | 
 | ||||||
| <!-- code_chunk_output --> | <!-- code_chunk_output --> | ||||||
| 
 | 
 | ||||||
| * [About](#about) | - [About](#about) | ||||||
| * [Contribution](#contribution) | - [Usage](#usage) | ||||||
|   + [Prerequisite](#prerequisite) | - [Contribution](#contribution) | ||||||
|   + [Create a new package](#create-a-new-package) |   - [Prerequisite](#prerequisite) | ||||||
|  |   - [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) | ||||||
| * [Usage](#usage) | - [Simple work flow diagramm](#simple-work-flow-diagramm) | ||||||
| * [Simple work flow diagramm](#simple-work-flow-diagramm) | - [Status](#status) | ||||||
| * [Status](#status) | - [License](#license) | ||||||
| * [License](#license) |  | ||||||
| 
 | 
 | ||||||
| <!-- /code_chunk_output --> | <!-- /code_chunk_output --> | ||||||
| 
 | 
 | ||||||
| @ -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 | ## Contribution | ||||||
| 
 | 
 | ||||||
| Clone this repo. | 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: | To create a new package in the packages/ folder, run the following command in the terminal: | ||||||
| 
 | 
 | ||||||
| ```shell | ```shell | ||||||
| mason make wyatt_package_template --package_name <name> --description A new Wyatt package --flutter false | mason upgrade | ||||||
|  | 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. | The `<name>` 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. | 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: | 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: `example` | 2. example name: `wyatt_crud_bloc_example` | ||||||
| 
 | 
 | ||||||
| ### Create issues | ### 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: | 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` . | 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. | * `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: | ||||||
| 
 | 
 | ||||||
| ```shell | ```text | ||||||
| feat(auth): add AWS support. (closes #31) | feat(auth): add AWS support. (closes #31) | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| @ -262,22 +284,7 @@ or | |||||||
| 
 | 
 | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| > Some packages requires Flutter, so please specify it. | > **Warning** 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. |  | ||||||
| 
 | 
 | ||||||
| --- | --- | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -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"}}}} | {"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"}}}} | ||||||
										
											Binary file not shown.
										
									
								
							| Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 31 KiB | 
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user