Skip to content

Commit 4c689a2

Browse files
committed
docs: improve details about contributions
Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
1 parent d486dc7 commit 4c689a2

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

.github/CONTRIBUTING.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,16 @@
1515

1616
Looking to contribute something OUDS iOS? **Here's how you can help.**
1717

18-
Please take a moment to review this document in order to make the contribution process easy for everyone involved.
18+
> [!TIP]
19+
> Please take a moment to review this document in order to make the contribution process easy for everyone involved.
1920
20-
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this Open Source project.
21-
In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
21+
> [!IMPORTANT]
22+
> Following these guidelines helps to communicate that you respect the time of the developers managing and developing this Open Source project.
23+
> In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
2224
23-
You should also have a look on the wiki if you are looking for information about how the project is managed, the releases and tests done, and how to do some actions.
24-
[The wiki define the way to work anyone must agree](https://github.com/Orange-OpenSource/ouds-ios/wiki).
25-
[The Code of Conduct](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/blob/develop/.github/CODE_OF_CONDUCT.md) defines how we should interact together.
25+
You should also have a look on the wiki if you are looking for information about how the project is managed, the releases and tests done, and how to do some actions:
26+
- [The wiki define the way to work anyone must agree](https://github.com/Orange-OpenSource/ouds-ios/wiki).
27+
- [The Code of Conduct](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/blob/develop/.github/CODE_OF_CONDUCT.md) defines how we should interact together.
2628

2729
## Using the Issue Tracker
2830

@@ -40,7 +42,7 @@ The OUDS project contains two repositories: one for the [Swift Package library](
4042

4143
Because today we want to have [one board for both repositories](https://github.com/orgs/Orange-OpenSource/projects/40/views/4), there is no board no issues tracker for this app GitHub project, and anything is centralized in the library GitHub project.
4244

43-
Thus, if you want to refer to an issue in the other project in commits, CHANGELOG, issues, pull requests or discussions, you msut use the [GitHub dedicated convention](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls) about issues references.
45+
Thus, if you want to refer to an issue in the other project in commits, CHANGELOG, issues, pull requests or discussions, you must use the [GitHub dedicated convention](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls) about issues references.
4446
In few words, if you are on an issue n°42 in [ouds-ios](https://github.com/Orange-OpenSource/ouds-ios), do not mention `#42` in your messages, but `Orange-OpenSource/ouds-iOS#42`.
4547

4648
## Using the Discussion Tracker
@@ -106,7 +108,10 @@ Good pull requests (patches, improvements, new features) are a fantastic help. T
106108

107109
Please adhere to the [coding guidelines](#code-guidelines) used throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).
108110

109-
Adhering to the following process is the best way to get your work included in the project:
111+
Adhering to the following process is the best way to get your work included in the project.
112+
113+
> [!TIP]
114+
> Of course you can use GUI tools if your are not used to CLI
110115
111116
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, and configure the remotes:
112117

@@ -153,7 +158,7 @@ Adhering to the following process is the best way to get your work included in t
153158

154159
Note that a ruleset based [on task-list-completed tool](https://github.com/marketplace/task-list-completed) is applied on `develop` branch: if any prerequisites are not futfilled in the pull request ticket the merge won't be done.
155160

156-
8. If your evolutions are bout the [Swift package](https://github.com/Orange-OpenSource/ouds-ios/), add in your pull request the details about it (branch to test, associated pull request, etc.). **Copy/paste the Swift pakcage changelog line in the app changelog with cross-linked issues** ; thus for alpha, beta and production builds the changelog of the app will mirror the changelog of the package
161+
8. If your evolutions are bout the [Swift package](https://github.com/Orange-OpenSource/ouds-ios/), add in your pull request the details about it (branch to test, associated pull request, etc.). **Copy/paste the Swift package changelog line in the app changelog with cross-linked issues** ; thus for alpha, beta and stable builds the changelog of the app will mirror the changelog of the package.
157162

158163
## Code Guidelines
159164

@@ -171,7 +176,7 @@ If your commits embed contributions for other people, do not forget to [add them
171176
For example, given a commit to fix the issue n°43, the commit should be like:
172177

173178
```text
174-
fix: title of your commit (#43)
179+
fix: title of your commit (Orange-OpenSource/ouds-ios#43)
175180
176181
Some details about the fix you propose
177182
@@ -182,7 +187,7 @@ Signed-off-by: Author firstname and lastname <first author email>
182187
If the commit embeds work of several authors, use the *Co-authored-by* tag (in use in GitHub):
183188

184189
```text
185-
fix: title of your commit (#43)
190+
fix: title of your commit (Orange-OpenSource/ouds-ios#43)
186191
187192
Some details about the fix you propose
188193
@@ -197,7 +202,7 @@ If the feature has been reviewed by the product owner, the designers and the acc
197202
It can help to find who reviewed, in alpha builds, the evolutions. Thus, the message for the merge commit should be like:
198203

199204
```text
200-
fix: title of your commit (#43)
205+
fix: title of your commit (Orange-OpenSource/ouds-ios#43)
201206
202207
Some details about the fix you propose
203208
@@ -211,21 +216,20 @@ Signed-off-by: Second author firstname and lastname <second author email>
211216
Do not forget also to add, in the merge commit, who reviewed the source code evolutions using the [*Reviewed-by*](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst#n525) tag, like:
212217

213218
```text
214-
fix: title of your commit (#43)
219+
fix: title of your commit (Orange-OpenSource/ouds-ios#43)
215220
216221
Some details about the fix you propose
217222
218223
Reviewed-by: Reviewer firstname and lastname <reviewer email>
219224
Signed-off-by: Author firstname and lastname <first author email>
220225
```
221226

222-
For example, for issue n°123 and its pull request n°456, tested by Anton, Iman, Maxime and Benoit, reviewed by Ludovic, authored by Tayeb and Pierre-Yves, and acked by Julien:
227+
For example, for issue n°123 and its pull request n°456, tested by Anton, Maxime and Benoit, reviewed by Ludovic, authored by Tayeb and Pierre-Yves, and acked by Julien:
223228
```text
224-
refactor: update some things colors and design of the demo app (#123) (#4562)
229+
refactor: update some things colors and design of the demo app (Orange-OpenSource/ouds-ios#123) (#456)
225230
226231
Some things have been refactored to make incredible things.
227232
228-
Tested-by: Iman Assabah <[email protected]>
229233
Tested-by: Anton Astafev <[email protected]>
230234
Tested-by: Benoit Suzanne <[email protected]>
231235
Tested-by: Maxime Tonnerre <[email protected]>
@@ -240,7 +244,7 @@ Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
240244
Finaly, if you want to note somewhere you used *generative AI* tool, you can add the field "Assisted-by" in your commit with the model in use and in parenthsies some commercial name.
241245

242246
```text
243-
feat: add thousands of tokens (#666)
247+
feat: add thousands of tokens (Orange-OpenSource/ouds-ios#123)
244248
245249
Add thousands of tokens and hundreds of tests.
246250

0 commit comments

Comments
 (0)