Skip to content

Commit 709d4e5

Browse files
florentmaitreflorentmaitre
authored
chore: release 0.2.0
2 parents 634583f + b6f347b commit 709d4e5

File tree

4,862 files changed

+638612
-4792
lines changed

Some content is hidden

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

4,862 files changed

+638612
-4792
lines changed

CODE_OF_CONDUCT.md renamed to .github/CODE_OF_CONDUCT.md

File renamed without changes.

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

File renamed without changes.

‎.github/CONTRIBUTORS.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# OUDS Android contributors
2+
3+
Here is the official list of people who contributed to the ouds-android repository.
4+
5+
> Names should be added to this file like so:
6+
> * [Contributor #1](http://LINK_TO_GH_PROFILE) - \<submission email address\>
7+
> * [Contributor #2](http://LINK_TO_GH_PROFILE) - \<submission email address\>
8+
> * so on...
9+
>
10+
> Please, keep the list sorted.
11+
12+
## Special thanks for all the people who had helped this project so far:
13+
14+
* [Pauline AUVRAY](https://github.com/paulineauvray) - <[email protected]>
15+
* [Julien DERAMOND](https://github.com/JulienDeramond) - <[email protected]>
16+
* [Pierre-Yves LAPERSONNE](https://github.com/pylapp) - <[email protected]>
17+
* [Florent MAITRE](https://github.com/florentmaitre) - <[email protected]>
18+
* [Mark SEIF](https://github.com/markoeltiger) - <[email protected]>
19+
20+
## You would like to join this list?
21+
22+
To contribute, please refer to our [CONTRIBUTING](CONTRIBUTING.md) guide.

‎.github/DEVELOP.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Developer guide
2+
3+
## Documentation
4+
5+
OUDS Android documentation is generated using [Dokka](https://github.com/Kotlin/dokka).
6+
7+
You can test the documentation locally by launching the `dokkaGenerate` Gradle task.
8+
9+
```
10+
./gradlew dokkaGenerate
11+
```
12+
13+
When generated, click on the HTML link provided by the task: [http://localhost:63342/OUDS%20Android/core/build/dokka/html/index.html](http://localhost:63342/OUDS%20Android/core/build/dokka/html/index.html).
14+
15+
## Tests
16+
17+
Each component offered by OUDS Android has two kinds of tests: Android instrumented tests and [Paparazzi](https://github.com/cashapp/paparazzi) tests.
18+
19+
The instrumented tests are in `core/src/androidTest` and allow to test interactions and behaviors.
20+
21+
The [Paparazzi](https://github.com/cashapp/paparazzi) tests are in `core/src/test`. They generate snapshots of the components in their various
22+
state (pressed, hover, focused, disabled, ...) and compare them to reference snapshots in order to identify possible regressions.
23+
You can generate reference snapshots of the components by launching the `recordPaparazzi` or the `cleanRecordPaparazzi` Gradle task.
24+
25+
```
26+
./gradlew recordPaparazzi
27+
```
28+

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: Report a bug
2-
description: Tell us about a bug or issue you may have identified in OUDS Android.
3-
title: "[Bug]: Bug Summary"
4-
labels: ["🐞 bug", "🔍 triage"]
5-
assignees: ["florentmaitre", "paulinea"]
2+
description: Tell us about a bug or issue you may have identified in OUDS Android
3+
title: "Bug - <Write here the bug summary>"
4+
labels: [ "🐞 bug", "🔍 triage" ]
5+
assignees: [ "florentmaitre", "paulinea" ]
66
body:
77
- type: checkboxes
88
attributes:
@@ -15,15 +15,13 @@ body:
1515
id: device
1616
attributes:
1717
label: Your test device
18-
description:
1918
placeholder: Huawei Mate 20 Pro
2019
validations:
2120
required: true
2221
- type: input
2322
id: os-version
2423
attributes:
2524
label: OS Version
26-
description:
2725
placeholder: Android 10.x
2826
validations:
2927
required: true
@@ -38,7 +36,7 @@ body:
3836
id: what-happened
3937
attributes:
4038
label: Describe the issue
41-
description: Provide a summary of the issue, including specific steps to reproduce.
39+
description: Provide a summary of the issue, including specific steps to reproduce with as much detail as possible. Do not forget to hide sensitive or personal data (phone numbers, accounts, messages, emails etc).
4240
validations:
4341
required: true
4442
- type: textarea
@@ -48,3 +46,10 @@ body:
4846
description: Provide a description of what you expected to happen.
4947
validations:
5048
required: true
49+
- type: textarea
50+
id: a11y-settings
51+
attributes:
52+
label: Accessibility settings
53+
description: Provide a description about the accessibility settings you have (vocalization with Talkback, increased text sizes, keyboard navigation, high contrast, etc.)
54+
validations:
55+
required: false

‎.github/ISSUE_TEMPLATE/component_update.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Request a component update
2+
description: Propose a change for a specific component
3+
title: "Component update - <Write here the title of the update>"
4+
labels: [ "⚛️ component", "🔍 triage" ]
5+
assignees: [ "florentmaitre", "paulinea" ]
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: Describe your need in details
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: motivation_context
16+
attributes:
17+
label: Motivation & Context
18+
description: Why is this change required? What problem does it solve?
19+
- type: checkboxes
20+
attributes:
21+
label: Checklist for the Core Team
22+
description: Some points to check before any merge
23+
options:
24+
- label: Tokens have been updated
25+
- label: Documentations have been updated
26+
- label: Unit tests have been updated
27+
- label: UI tests have been updated
28+
- label: Design System Toolbox has been updated
29+
- label: Backward compatibility has been checked, or broken API have been flagged as deprecated with a workaround

‎.github/ISSUE_TEMPLATE/demo_app_update.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Request demo app update
2+
description: Propose a change in the Design Toolbox demo application
3+
title: "Demo App - <Write here the title of the update>"
4+
labels: [ "📱 demo app", "🔍 triage" ]
5+
assignees: [ "florentmaitre", "paulinea" ]
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: Describe your need in details. Which screens? Which tokens, components or modules?
12+
validations:
13+
required: true
14+
- type: checkboxes
15+
attributes:
16+
label: Checklist for the Core Team
17+
description: Some points to check before any merge
18+
options:
19+
- label: Unit tests have been updated and still pass
20+
- label: UI tests have been updated and still pass
21+
- label: A11y tests are ok

‎.github/ISSUE_TEMPLATE/documentation-update.yml‎

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/documentation_update.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Documentation Update
2+
description: Propose a documentation change
3+
title: "Documentation - <Write here the title of the update>"
4+
labels: [ "📖 documentation", "🔍 triage" ]
5+
assignees: [ "florentmaitre", "paulinea" ]
6+
body:
7+
- type: textarea
8+
id: location
9+
attributes:
10+
label: Documentation Location
11+
description: Where in the documentation should there be an update.
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: what-happened
16+
attributes:
17+
label: Current issue
18+
description: A description of what is currently in the doc.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: correction
23+
attributes:
24+
label: Expected Correction
25+
description: A clear and concise description of what you expected to be updated.
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: other
30+
attributes:
31+
label: Additional context
32+
description: Add any other context about the problem here.
33+
validations:
34+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: Feature Request
2-
description: Suggest a new Epic to be added to the backlog.
3-
title: "[feature]: "
4-
labels: ["🗳️ feature", "🔍 triage"]
5-
assignees: ["florentmaitre", "paulinea"]
2+
description: Suggest a new Epic to be added to the backlog
3+
title: "Feature - <Write here your feature summary>"
4+
labels: [ "🗳️ feature", "🔍 triage" ]
5+
assignees: [ "florentmaitre", "paulinea" ]
66
body:
77
- type: checkboxes
88
attributes:
@@ -18,24 +18,21 @@ body:
1818
- type: textarea
1919
id: user
2020
attributes:
21-
label: As a
22-
description:
21+
label: As a
2322
placeholder: type of user / context of use
2423
validations:
2524
required: true
2625
- type: textarea
2726
id: need
2827
attributes:
2928
label: ... I want to
30-
description:
3129
placeholder: perform some task
3230
validations:
3331
required: true
3432
- type: textarea
3533
id: goal
3634
attributes:
3735
label: ... so that I can
38-
description:
3936
placeholder: achieve some goal
4037
validations:
4138
required: true

0 commit comments

Comments
 (0)