Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
name: Bug Report
description: Report a reproducible bug
title: '[Bug] '
labels: ['bug']
title: "[Bug] "
labels: ["bug"]
assignees: []

body:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/2-feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
name: Feature Request
description: Suggest a feature or improvement
title: '[Feature] '
labels: ['enhancement']
title: "[Feature] "
labels: ["enhancement"]
assignees: []

body:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/3-other.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# SPDX-License-Identifier: Apache-2.0
name: Other
description: Use this for anything that doesn't fit the other templates
title: '[Other] '
labels: ['discussion']
title: "[Other] "
labels: ["discussion"]
assignees: []

body:
Expand Down
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Briefly describe the purpose of this PR and what changes it introduces.
- [ ] Commits are **signed** (`git commit -S`)
- [ ] Commit messages follow **Conventional Commits**
- [ ] Documentation has been updated (if needed)
- [ ] The target branch follows the git flow model (`develop` for feature/fix PRs, `main` for release/hotfix PRs)
- [ ] PRs targeting `main` have a `release-type/...` label or are intentionally marked `skip-release`
- [ ] I have read and agree to the project’s [Code of Conduct](../CODE_OF_CONDUCT.md)
- [ ] I have signed the [Contributor License Agreement (CLA)](../CONTRIBUTING.md)

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/code-PR_verify-fallback.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@

jobs:
unit-tests:
if: 'false'
if: "false"
name: Code / Verify
runs-on: ubuntu-24.04
steps:
- run: echo "No Code / Verify required"

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {}
7 changes: 6 additions & 1 deletion .github/workflows/code-npm_node-sonarcloud-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ jobs:
permissions:
contents: read
timeout-minutes: 30
if: ${{ (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' || github.event_name == 'release') && vars.IS_INDITEXTECH_REPO == 'true' }}
if: >-
${{
(github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' || github.event_name == 'release')
&& vars.IS_INDITEXTECH_REPO == 'true'
&& vars.SONARCLOUD_ENABLED == 'true'
}}
runs-on: ubuntu-24.04
steps:
- name: Checkout
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/pr-verify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ jobs:
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.sha }}
ref: ${{ github.event.pull_request.head.sha || github.sha }}

- name: 'Run Repolinter'
- name: "Run Repolinter"
uses: newrelic/repolinter-action@3f4448f855c351e9695b24524a4111c7847b84cb # v1.7.0

reuse-compliance:
Expand All @@ -31,7 +31,7 @@ jobs:
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.sha }}
ref: ${{ github.event.pull_request.head.sha || github.sha }}

- name: REUSE Compliance Check
uses: fsfe/reuse-action@bb774aa972c2a89ff34781233d275075cbddf542 # v5
Expand All @@ -44,6 +44,6 @@ jobs:
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.sha }}
ref: ${{ github.event.pull_request.head.sha || github.sha }}

- uses: webiny/action-conventional-commits@8bc41ff4e7d423d56fa4905f6ff79209a78776c7 # v1.3.0
7 changes: 3 additions & 4 deletions .github/workflows/push-verify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ name: Push Verification
permissions: read-all
on:
push:
# Only the default branch is supported.
branches: [ 'main' ]

# Run on the long-lived git-flow branches.
branches: ["develop", "main"]

jobs:
scorecard-analysis:
Expand Down Expand Up @@ -53,7 +52,7 @@ jobs:
- name: Checkout
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: 'Run Repolinter'
- name: "Run Repolinter"
uses: newrelic/repolinter-action@3f4448f855c351e9695b24524a4111c7847b84cb # v1.7.0

reuse-compliance:
Expand Down
49 changes: 42 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,44 @@
node_modules/
.npm/
# dependencies
/node_modules
example/node_modules
/.pnp
.pnp.js

dist/
coverage/
.nyc_output/
# testing
/coverage

*.log
.DS_Store
# production build
/build
/dist
example/build

# environment files
.env
.env.local
.env.development.local
.env.test.local
.env.production.local
# keep the example's source-map setting tracked so the demo starts cleanly
!example/.env

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

# caches
.eslintcache
.cache
.parcel-cache

# editor / IDE
.vscode/*
!.vscode/settings.json
!.vscode/extensions.json
.idea

# OS files
.DS_Store
Thumbs.db
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist
node_modules
example
package-lock.json
3 changes: 3 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"trailingComma": "es5"
}
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added

- Initial OSS repository shell.
- Original code, including the diff highlighting plugin, and the example React application.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ SPDX-License-Identifier: Apache-2.0

By participating in this project, you agree to abide by the rules and principles outlined in the Code of Conduct. Please review it to understand the expectations for respectful and inclusive collaboration.

This project adheres to the general [Inditex Tech Code of Conduct](https://github.com/sudo InditexTech/foss/blob/main/CODE_OF_CONDUCT.md).
This project adheres to the general [Inditex Tech Code of Conduct](https://github.com/InditexTech/foss/blob/main/CODE_OF_CONDUCT.md).

For any inquiries regarding this Code of Conduct, please contact us at oso@inditex.com.
22 changes: 13 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,33 @@ To maintain a collaborative and respectful environment, please consider the foll

1. Open an issue to discuss and gather feedback on the feature or fix you wish to address.
2. Fork the repository and clone it to your local machine.
3. Create a new branch to work on your contribution: `git checkout -b your-branch-name`.
3. Create a new branch from the latest `develop` branch to work on your contribution:
`git checkout -b feature/your-branch-name`.
4. Make the necessary changes in your local branch.
5. Ensure that your code follows the established project style and formatting guidelines.
6. Perform testing to ensure your changes do not introduce errors.
7. Make clear and descriptive commits that explain your changes.
8. Push your branch to the remote repository: `git push origin your-branch-name`.
9. Open a pull request describing your changes and linking the corresponding issue.
9. Open a pull request against `develop` describing your changes and linking the corresponding issue.
10. Await comments and discussions on your pull request. Make any necessary modifications based on the received feedback.
11. Once your pull request is approved, your contribution will be merged into the main branch.
11. Once your pull request is approved, your contribution will be merged into `develop`.

Project maintainers prepare releases by opening `release/*` or `hotfix/*` pull requests against `main`. Release pull
requests must include a `release-type/...` label unless the release is intentionally skipped.

## Contribution Guidelines

- All contributors are expected to follow the project's [code of conduct](CODE_of_CONDUCT.md). Please be respectful and
considerate towards other contributors.
- All contributors are expected to follow the project's [code of conduct](CODE_OF_CONDUCT.md). Please be respectful and
considerate towards other contributors.
- Before starting work on a new feature or fix, check existing [issues](../../issues) and [pull requests](../../pulls)
to avoid duplications and unnecessary discussions.
to avoid duplications and unnecessary discussions.
- If you wish to work on an existing issue, comment on the issue to inform other contributors that you are working on it.
This will help coordinate efforts and prevent conflicts.
This will help coordinate efforts and prevent conflicts.
- It is always advisable to discuss and gather feedback from the community before making significant changes to the
project's structure or architecture.
project's structure or architecture.
- Ensure a clean and organized commit history. Divide your changes into logical and descriptive commits. We recommend to use the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
- Document any new changes or features you add. This will help other contributors and project users understand your work
and its purpose.
and its purpose.
- Be sure to link the corresponding issue in your pull request to maintain proper tracking of contributions.
- Remember to add license and copyright information following the [REUSE Specification](https://reuse.software/spec/#copyright-and-licensing-information).

Expand Down
Loading
Loading