diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index f8a86a5f5..a6d6fd476 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -51,7 +51,7 @@ jobs: if: ${{ steps.health-check.conclusion == 'success' }} run: pnpm test:coverage -- --max-warnings=0 - - uses: sonarsource/sonarqube-scan-action@master + - uses: sonarsource/sonarqube-scan-action@v3 if: ${{ steps.unit-tests.conclusion == 'success' && github.actor != 'dependabot[bot]' && github.event.pull_request.head.repo.fork == 'false' }} env: SONAR_TOKEN: ${{ secrets.GREEN_SONAR_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3172664cf..aa119ca9e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,20 +38,29 @@ We use the following git conventions for the `Device Management Kit` monorepo. Depending on the purpose every git branch should be prefixed. -- `feat/` Add a new feature to the application or library -- `bugfix/` Fixing an existing bug -- `support/` for any other changes (tests, improvements, CI…) +- `feat/` / `feature/` Add a new feature to the application or library +- `bugfix/` / `bug/` / `fix/` Fixing an existing bug +- `support/` For any other changes (tests, improvements, CI…) _For Ledger Employees:_ -- `chore/` Cleaning purpose +- `chore/` / `core/` For maintenance work on the repo - `doc/` Add or modify documentation -- `refacto/` Modify the code organisation +- `refacto/` / `refactor/` Modify the code organisation -Then add to the prefix no-issue -_For Ledger Employees:_ Add the Jira ticket number `DSDK-` +_For Ledger Employees only:_ Add the Jira ticket number `DSDK-` _(case insensitive)_ or `NO-ISSUE` if not applicable. -And finally add a small description. +_If resolving a Github issue (optional and not to be combined with Jira ticket number):_ add `ISSUE-` + +Followed by a small description. + +**Examples:** + +| User type | Ticket | Example | +| -- | -- | -- | +| `employee` | yes | feature/dsdk-350-add-sparkles | +| `employee` | no | refacto/no-issue-remove-sparkles | +| `contributor` | yes | feat/issue-37-add-new-transport | +| `contributor` | no | fix/missing-dependencies | -**Example:** doc/no-issue-update-readme #### Changelogs @@ -91,7 +100,7 @@ The description format is similar to gitmoji: 1. scope is the module/package that is impacted by the update (should be the same than the commit ones). -2. _For Ledger Employees:_ `NO-ISSUE` to be replace by `DSDK-` in case of tracking. +2. _For Ledger Employees:_ `NO-ISSUE` to be replace by `DSDK-` or `ISSUE-` in case of tracking 3. `` should start with an uppercase. @@ -107,6 +116,8 @@ The description format is similar to gitmoji: - Your PR must pass the required CI actions. - Your PR must include a changelog (`pnpm changeset`), except for tools and maintenance operations. +_For external contributors:_ a member of the Ledger will be required to validate the execution of the CI for external contributions + ### Developer Portal Ledger provides the tools and resources you need to build on top of our platform. They are accessible in the [Ledger Developer Portal](https://developers.ledger.com/). diff --git a/LICENSE.MD b/LICENSE.MD new file mode 100644 index 000000000..d6b0e5319 --- /dev/null +++ b/LICENSE.MD @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024-present Ledger + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index 723b54b7e..b90d78b08 100644 --- a/README.md +++ b/README.md @@ -289,18 +289,16 @@ pnpm dev Each project folder has a `README.md` file which contains basic documentation. It includes background information about the project and how to setup, run and build it. -Please check the [**wiki**](https://github.com/LedgerHQ/device-sdk-ts/wiki) for additional documentation. - ## Reference API -Please refer to the core package [**readme**](https://github.com/LedgerHQ/device-sdk-ts/packages/core/README.md). +Please refer to the core package [**readme**](https://github.com/LedgerHQ/device-sdk-ts/blob/develop/packages/core/README.md). # Contributing -Please check the general guidelines for contributing to Ledger Live projects: [`CONTRIBUTING.md`](https://github.com/LedgerHQ/device-sdk-ts/CONTRIBUTING.md). +Please check the general guidelines for contributing to Ledger Live projects: [`CONTRIBUTING.md`](https://github.com/LedgerHQ/device-sdk-ts/blob/develop/CONTRIBUTING.md). Each individual project may include its own specific guidelines, located within its respective folder. # License -Please check each project `LICENSE` file, most of them are under the `MIT` license. +Please check each project [`LICENSE`](https://github.com/LedgerHQ/device-sdk-ts/blob/develop/LICENSE.md) file, most of them are under the `MIT` license. diff --git a/danger/helpers.ts b/danger/helpers.ts index 34e3edad2..b046f3bee 100644 --- a/danger/helpers.ts +++ b/danger/helpers.ts @@ -53,7 +53,7 @@ const Branch = ( regex: isFork ? new RegExp(`^(${BRANCH_PREFIX.join("|")})\/.+`, "i") : new RegExp( - `^(${BRANCH_PREFIX.join("|")})\/((dsdk)-[0-9]+|no-issue)\-.+`, + `^(${BRANCH_PREFIX.join("|")})\/((dsdk)-[0-9]+|no-issue|issue-[0-9]+)\-.+`, "i" ), @@ -91,7 +91,7 @@ Please fix the PR branch name to match the convention, see [CONTRIBUTING.md](htt - Rules: - Must start with a type (${BRANCH_PREFIX.join(", ")}) - Followed by a SLASH ("/") - - Followed by a JIRA issue number (DSDK-1234) or "no-issue" + - Followed by a JIRA issue number (DSDK-1234) or "no-issue" or "issue-1234" if fixing a Github issue - Followed by a DASH ("-") - Followed by a description @@ -181,7 +181,7 @@ export const checkCommits = ( const Title = (danger: DangerDSLType, fail: FailFn, fork: boolean = false) => ({ regex: fork ? /^.+ \(([a-z]+\-?){1,}\): [A-Z].*/ - : /^.+ \(([a-z]+\-?){1,}\) \[(DSDK-[0-9]+|NO-ISSUE)\]: [A-Z].*/, + : /^.+ \(([a-z]+\-?){1,}\) \[(DSDK-[0-9]+|NO-ISSUE|ISSUE-[0-9]+)\]: [A-Z].*/, fail(wrongTitle: string) { if (fork) { @@ -195,6 +195,9 @@ Please fix the PR title to match the convention, see [CONTRIBUTING.md](https://g - Must start with a word (usually an emoji) - Followed by a SPACE - Followed by a scope in parentheses and in LOWERCASE + - _Optional_ + - _Followed by a SPACE_ + - _Followed by ISSUE- to reference a Github issue_ - Followed by a colon (":") and a SPACE - Followed by a Capitalized message @@ -213,7 +216,7 @@ Please fix the PR title to match the convention, see [CONTRIBUTING.md](https://g - Followed by a SPACE - Followed by a scope in parentheses and in LOWERCASE - Followed by a SPACE - - Followed by a JIRA issue number in [brackets] (uppercase) + - Followed by a JIRA issue number or NO-ISSUE or ISSUE- in [brackets] (uppercase) - Followed by a colon (":") and a SPACE - Followed by a Capitalized message