Skip to content

Commit 870e961

Browse files
Tayebsed93B3nz01dflorentmaitreboosted-botThelm76
authored
Version 0.2.0 (#169)
Version 0.2.0 (#169) Release of version 0.2.0 See below the full CHANGELOG details. Added: - [DemoApp][Library] Create component - `Checkbox` (#47) - [DemoApp][Library] RTL : activation of RTL mode / manage arabic language (#134) - [DemoApp] Tokens: screen opacity (#123) - [DemoApp] Migration of PNG Illustrations to SVG (#143) - [DemoApp] Tokens: screen color (#124) - [Library] `RadioButton` component (tokens library v0.11.0) (#145) - [Library] `ControlItem` component (tokens library v0.11.0) (#132) - [DemoApp] Tokens: screen elevation (#84) - [Library] `Chekbox` component (tokens library v0.8.0) (#120) Changed: - [Library] Update of tokens (library version 0.11.0) (#126) - Add @nouha06 and @AhmedAmineZr as new contributor in project (#127) - [Library] Update of tokens (library version 0.10.0) (#125) - [Library] Update of tokens (library version 0.9.0) (#121) Fixed: - [DemoApp] Limited `bottomsheet` height to half screen (#89) - [DemoApp] A11y improvements for `bottomsheet` component (#89) - [DemoApp] Update dart-define env to retrieve flavor (#110) - [DemoApp] Icon system not adapting to light/dark mode (#112) --------- Signed-off-by: Tayeb Sedraia <[email protected]> Signed-off-by: Nouha Hammami < [email protected] > Signed-off-by: Ahmed Amine Zribi <ahmedamine.zribi@sofrecom> Co-authored-by: Benoit SUZANNE <[email protected]> Co-authored-by: Florent Maitre <[email protected]> Co-authored-by: OUDS Bot [bot] <[email protected]> Co-authored-by: boosted-bot <[email protected]> Co-authored-by: Mateo M. <[email protected]> Co-authored-by: Mateo MARTINEZ <[email protected]> Co-authored-by: Ahmed Amine Zribi <ahmedamine.zribi@sofrecom> Co-authored-by: Nouha Hammami <[email protected]>
1 parent 6967c59 commit 870e961

File tree

182 files changed

+5659
-849
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

182 files changed

+5659
-849
lines changed

.github/AUTHORS.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# This is the official list of ouds-ios authors for copyright purposes.
2+
# This file is distinct from the CONTRIBUTORS files.
3+
# See the latter for an explanation.
4+
5+
# Names should be added to this file as one of
6+
# Organization's name
7+
# Individual's name <submission email address>
8+
# Individual's name <submission email address> <email2> <emailN>
9+
# See CONTRIBUTORS for the meaning of multiple email addresses.
10+
11+
# Please keep the list sorted.
12+
13+
Orange SA
File renamed without changes.

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,39 @@ Adhering to the following process is the best way to get your work included in t
119119

120120
Format your code before committing to ensure your changes follow our coding standards.
121121

122+
## Review workflow
123+
124+
Because we want to define and provide an amazing design system for developers, we want to onboard for any evolutions the Q/A team for tests and also the design ans accessibiltiy (a11y) teams so as to check the fixes, patches or evolutions have been well implemented and tested.
125+
126+
The following chart explain how the review is done with also the intermediate alpha builds.
127+
In few words, alpha builds are made for reviewers, and the merge is processed if and only if any review have been done.
128+
129+
```mermaid
130+
flowchart TD
131+
A[New evolution needed, feature or bug fix] --> |Define needs and acceptance criteria| B(Create issue on GitHub)
132+
B --> C(Implementation or refactoring in GitHub branch)
133+
C --> |Code review| D{Code review OK?}
134+
D --> |No| C
135+
D --> |Yes| E(Build alpha version on TestFlight ‘ios‘ and Firebase ‘android‘)
136+
E --> F(Update GitHub PR with details of alpha build)
137+
F --> G{Feature ready for review}
138+
G --> |Test of feature| H{Tests OK?}
139+
H --> |No| C
140+
G -->|Design review| I{Design review OK?}
141+
I --> |No| C
142+
G -->|A11Y review| J{A11Y review OK?}
143+
J --> |No| C
144+
H --> |Yes| K
145+
I --> |Yes| K
146+
J --> |Yes| K
147+
K[Merge in develop branch] --> |Nightly build| L(Beta build on TestFlight ‘ios‘ and Firebase ‘android‘)
148+
L --> M(Update GitHub issue with details of beta build)
149+
```
150+
151+
Pull requests will be merged if no conditions / prerequisites / checks are red (except DCO which is not - yet - mandatory, but we must at least outside contributors to apply it). Some _GitHub Actions_ workflows are defined:
152+
- [task-list-completed GitHub app](https://github.com/apps/task-list-completed) prevents pull requests to be merged if some mandatory / not optional prerequisites are not filled ;
153+
- another [workflow YAML](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/build.yml) building and testing the app / lib;
154+
122155
## License
123156

124157
By contributing your code, you agree to license your contribution under the [MIT License](LICENSE).

.github/CONTRIBUTORS.txt

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# This is the official list of people have contributed code to the
2+
# ouds-flutter repository.
3+
#
4+
# The AUTHORS file lists the copyright holders; this file
5+
# lists people. For example, Orange employees are listed here
6+
# but not in AUTHORS, because Orange holds the copyright.
7+
#
8+
# When adding J Random Contributor's name to this file,
9+
# either J's name or J's organization's name should be
10+
# added to the AUTHORS file, depending on who holds the copyright.
11+
#
12+
# Names should be added to this file like so:
13+
# Individual's name <submission email address>
14+
# Individual's name <submission email address> <email2> <emailN>
15+
#
16+
# An entry with multiple email addresses specifies that the
17+
# first address should be used in the submit logs and
18+
# that the other addresses should be recognized as the
19+
# same person.
20+
21+
# Please keep the list sorted.
22+
23+
Julien DERAMOND <[email protected]>
24+
Tayeb SEDRAIA <[email protected]>
25+
Ahmed Amine ZRIBI <[email protected]>
26+
HAMMAMI Nouha <[email protected]>

.github/DEVELOP.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Developer Guide
2+
3+
- [Technical Preconditions](#technical-preconditions)
4+
* [Dependency Management](#dependency-management)
5+
* [Generation of Localization Files in the app and ouds_core Folders](#generation-of-localization-files-in-the-app-and-ouds_core-folders)
6+
- [Commits, Changelog, Release Notes, Versioning](#commits-changelog-release-notes-versioning)
7+
* [Commit Guidelines](#commit-guidelines)
8+
* [Release Notes and Changelog](#release-notes-and-changelog)
9+
- [Documentation](#documentation)
10+
- [Installation](#installation)
11+
* [Generating Docs](#generating-docs)
12+
13+
## Technical Preconditions
14+
15+
You can refer to the **THIRD_PARTY.md** file, which lists the dependencies and tools we use at different levels (SDK, design system toolbox app, and projects).
16+
Check the lock files (*pubspec* and *pubspec.lock*) to see which versions are being used.
17+
18+
### Dependency Management
19+
20+
The project uses **Pub Workspace** via [Pub Workspaces](https://dart.dev/tools/pub/workspaces).
21+
22+
The `pubspec.yaml` file at the root of the project manages all dependencies, so please use the following commands at the root to clean up the dependencies:
23+
24+
```bash
25+
flutter clean
26+
flutter pub get
27+
```
28+
29+
### Generation of Localization Files in the `app` and `ouds_core` Folders
30+
To generate the localization files for the project, use the `flutter gen-l10n` command for each folder (`app` and `ouds_core`).
31+
32+
You need to run this command because it generates the necessary localization files for your project, which helps Flutter manage translations for multiple languages. These files are crucial for the app to properly support localization and internationalization.
33+
34+
```bash
35+
flutter gen-l10n
36+
```
37+
38+
## Commits, Changelog, Release Notes, Versioning
39+
40+
### Commit Guidelines
41+
42+
#### Conventional Commit Rules
43+
44+
Please make every effort to follow [conventional commit rules](https://www.conventionalcommits.org/en/v1.0.0/).
45+
Ensure that your commits are properly prefixed and include the issue number in parentheses at the end. If applicable, also include the pull request issue number.
46+
If your commit includes contributions from others, don't forget to [add them as co-authors](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors).
47+
All contributors should also comply with the DCO.
48+
49+
Your commit messages should be prefixed with the following keywords (as specified in the [commit specification](https://www.conventionalcommits.org/en/v1.0.0/#specification)):
50+
- `fix:`
51+
- `feat:`
52+
- `build:`
53+
- `chore:`
54+
- `ci:`
55+
- `docs:`
56+
- `style:`
57+
- `refactor:`
58+
- `perf:`
59+
- `test:`
60+
61+
You can also add `!` after the keyword to indicate a breaking change, and include a scope in parentheses like:
62+
- `feat!:` breaking change because...
63+
- `feat(API)!:` breaking change in the API because...
64+
- `feat:` adding a new feature to the API...
65+
66+
#### Chain of Responsibility
67+
68+
We can include metadata from [this guideline](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst#n525) in the commit messages.
69+
This is not mandatory (yet), but it's a good practice to indicate who reviewed and validated each commit.
70+
You must mention *co-authors* (using `Co-authored-by`), and you should include who are the code reviewers (`Reviewed-by`), testers (`Tested-by`), and if needed, ackers (`Acked-by`).
71+
72+
### Release Notes and Changelog
73+
74+
We also aim to [keep a changelog](https://keepachangelog.com/en/1.0.0/) and apply [semantic versioning](https://semver.org/spec/v2.0.0.html) along with [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
75+
76+
## Documentation
77+
78+
OUDS Flutter documentation is generated using the [Dart documentation generator](https://pub.dev/packages/dartdoc).
79+
Open the `ouds-flutter/library/doc/api` directory.
80+
81+
More technical information about Dart documentation generation is available [here](https://pub.dev/packages/dartdoc).
82+
83+
## Installation
84+
85+
The `dart` tool, with the `dart doc` command, is part of the Dart SDK.
86+
87+
### Generating Docs
88+
89+
Run `dart doc .` from the `library/doc/api` directory of the package. You must first run `dart pub get` or `flutter pub get`, and your package must analyze without errors using `dart analyze` or `flutter analyze` as appropriate. Here's an example of `dartdoc` documenting itself:
90+
91+
```bash
92+
$ dart doc .

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Report a bug
22
description: Tell us about a bug or issue you may have identified in OUDS Flutter.
33
title: "[Bug]: Bug Summary"
44
labels: ["🐞 bug", "🔍 triage"]
5-
assignees: ["Tayebsed93"]
5+
assignees: ["Tayebsed93", "nouha06", "AhmedAmineZr"]
66
body:
77
- type: checkboxes
88
attributes:

.github/ISSUE_TEMPLATE/documentation-update.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Documentation Update
22
description: Describe this issue found in the documentation
33
title: "[Doc]: "
44
labels: ["📖 documentation", "🔍 triage"]
5-
assignees: ["Tayebsed93"]
5+
assignees: ["Tayebsed93", "nouha06", "AhmedAmineZr"]
66
body:
77
- type: markdown
88
attributes:

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Feature Request
22
description: Suggest a new Epic to be added to the backlog.
33
title: "[feature]: "
44
labels: ["🗳️ feature", "🔍 triage"]
5-
assignees: ["Tayebsed93"]
5+
assignees: ["Tayebsed93", "nouha06", "AhmedAmineZr"]
66
body:
77
- type: checkboxes
88
attributes:

.github/MAINTAINERS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
- [Overview](#overview)
2+
- [Current Maintainers](#current-maintainers)
3+
<!-- - [Emeritus](#emeritus) -->
4+
5+
## Overview
6+
7+
This document contains a list of maintainers in this repo. If you're interested in contributing, and becoming a maintainer, see [CONTRIBUTING](https://github.com/Orange-OpenSource/ouds-flutter/blob/develop/.github/CONTRIBUTING.md).
8+
9+
## Current Maintainers
10+
11+
<!-- Sort by alphabetic order, last name in upper case -->
12+
13+
| Maintainer | GitHub ID | Email | Affiliation |
14+
| -------------------- | ----------- | ------------------------------------ | -------------- |
15+
| Tayeb SEDRAIA | Tayebsed93 | [email protected] | OAB SA |
16+
| Ahmed Amine ZRIBI | AhmedAmineZr | [email protected] | SOFRECOM |
17+
| HAMMAMI Nouha | nouha06 | [email protected] | SOFRECOM |
18+
19+
<!--
20+
## Emeritus
21+
22+
| Maintainer | GitHub ID | Affiliation |
23+
| -------------------- | ----------- | -------------- |
24+
-->
25+

.github/SECURITY.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Security Policy
2+
3+
# Reporting Security Issues
4+
5+
We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
6+
Send an e-mail to [[email protected]](mailto:[email protected]) to report a vulnerability and contact all people in CONTRIBUTORS and MAINTAINERS including the word "SECURITY" in the subject line.
7+
8+
Please allow our team sufficient time to resolve the vulnerability before disclosing it ; we'll remain in contact about the fix and may ask for your assistance to verify it is resolved.
9+
10+
We will endeavor to respond quickly, and will keep you updated throughout the process.

0 commit comments

Comments
 (0)