Merge pull request #6 from BBVA/release/1.0.0

Release/1.0.0

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/workflows/build.yml

@@ -0,0 +1,17 @@
+name: Build node CI
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - run: npm ci
+      - run: npm run build --if-present

.github/workflows/publish.yml

@@ -0,0 +1,60 @@
+name: Publish to NPM
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies and build
+        run: |
+          npm i --package-lock-only
+          npm ci 
+          npm run build --if-present
+      - name: Publish core package on NPM.js
+        working-directory: ./packages/core
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+      - name: Publish core-plugin package on NPM.js
+        working-directory: ./packages/core-plugin
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+      - name: Publish element-controller package on NPM.js
+        working-directory: ./packages/element-controller
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+      - name: Publish page-controller package on NPM.js
+        working-directory: ./packages/page-controller
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+      - name: Publish page-mixin package on NPM.js
+        working-directory: ./packages/page-mixin
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+      - name: Publish page-transitions package on NPM.js
+        working-directory: ./packages/page-transitions
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+      - name: Publish localize package on NPM.js
+        working-directory: ./packages/localize
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+      - name: Publish create-app package on NPM.js
+        working-directory: ./packages/create-app
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

.gitignore

@@ -16,3 +16,6 @@ server
 /playwright/.cache/
 /packages/example/*
 !/packages/example/recipes-app/
+/packages/example/recipes-app/types/
+!/packages/example/blank-app/
+/packages/example/blank-app/types/

.npmrc

@@ -0,0 +1 @@
+registry="https://registry.npmjs.org/"

CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the project community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing
+
+## Contributing Policy
+
+Thank you for considering contributing to our project. Your interest and support are greatly appreciated.
+
+> This project adheres to the Contributor Covenant [code of conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
+
+As of the current moment, our project is focusing on actively managing and addressing issues within the repository. Therefore, **we are not accepting pull requests at this time.** Our team is dedicated to resolving existing issues and improving the project based on community feedback.
+
+If you encounter any issues or have suggestions for enhancements, please feel free to create a new issue outlining the situation in detail. We encourage you to contribute to the discussion and help us prioritize and resolve these matters.
+
+While we are not accepting pull requests at this time, your involvement through issue creation, feedback, and discussion is invaluable to the project's growth and development.
+
+We sincerely appreciate your understanding and cooperation in this matter. Your contributions, whether through issue reporting or other means, play a crucial role in making our project better for everyone.
+
+Please note that while we are not currently accepting pull requests, we plan to revisit this decision in the future as our project evolves. We appreciate your patience and understanding.
+
+<!--
+
+## Getting Started 
+
+First, create a fork of the [BBVA/open-cells](https://github.com/BBVA/open-cells) repository by hitting the `fork` button on the GitHub page.
+
+Next, clone your fork onto your computer (replacing YOUR_USERNAME with your actual GitHub username).
+
+```sh
+git clone [email protected]:YOUR_USERNAME/open-cells.git
+```
+
+Once cloning is complete, change directory to the repository and add the Open Web Components project as a remote.
+
+```sh
+cd open-cells
+git remote add upstream [email protected]:BBVA/open-cells.git
+```
+
+## Preparing Your Local Environment for Development
+
+Now that you have cloned the repository, ensure you have Node 18+ installed, then run the following command to set up the development environment.
+
+```sh
+npm install
+```
+
+This will download and install all packages needed.
+
+## Making Your Changes
+
+First, update your fork with the latest code from upstream, then create a new branch for your work.
+
+```sh
+git checkout master
+git pull upstream master --rebase
+git checkout -b my-awesome-fix
+```
+
+### Linting
+
+Commits are linted using precommit hooks, meaning that any code that raises a linting error cannot be committed. In order to help avoid that, we recommend using an IDE or editor with an ESLint plugin in order to streamline the development process. Plugins are available for all the popular editors. For more information see [ESLint Integrations](https://eslint.org/docs/user-guide/integrations)
+
+### Running Tests on Core
+
+To run the tests of core package, it's recommended to `cd` into the package directory and then using `npm test` to run them. This way you're only running tests of that specific package.
+
+### Creating a Changeset
+
+If you made changes for which you want to trigger a release, you need to create a changeset.
+This documents your intent to release and allows you to specify a message that will be put into the changelog(s) of the package(s).
+
+[More information on changesets](https://github.com/atlassian/changesets)
+
+To create a changeset, run:
+
+```sh
+npx changeset
+```
+
+Use the menu to select for which packages you need a release, and then select what kind of release. For the release type, we follow [Semantic Versioning](https://semver.org/), so please take a look if you're unfamiliar.
+
+In short:
+
+- A documentation change or similar chore usually does not require a release
+- A bugfix requires a patch
+- A new feature (feat) requires a minor
+- A breaking change requires a major
+
+Exceptions:
+
+- For alpha (<1.0.0), bugfixes and feats are both patches, and breaking changes are allowed as minors.
+- For release-candidate and other special cases, other rules may follow.
+
+## Committing Your Changes
+
+Commit messages must follow the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/).
+Open Cells uses the package name as the scope. So for example if you fix a _terrible bug_ in the package `@open-cells/core`, the commit message should look like this:
+
+```sh
+fix(core): fix terrible bug
+```
+
+## Create a Pull Request
+
+After you commit your changes, it's time to push your branch.
+
+```sh
+git push -u origin my-awesome-fix
+```
+
+After a successful push, visit your fork on GitHub. You should see a button that will allow you to create a pull request.
+
+-->