Merge pull request #26 from Shopify/make-repo-public

quifago · web-flow · commit 4defe5e2ffb4 · 2025-06-20T17:56:14.000+02:00
needed docs for making a repo public
diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml
@@ -0,0 +1,23 @@
+# .github/workflows/cla.yml
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      )
+|| (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,49 @@ build
 .DS_Store
 .eslintcache
 *.tsbuildinfo
+
+# Shopify specific
+.shopify
+.shopify-cache
+*.shopify.yml
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Dependencies
+/vendor/
+bower_components/
+
+# Testing
+coverage/
+.nyc_output
+
+# Production
+dist/
+out/
+
+# Misc
+.cache
+.temp
+.tmp
+*.bak
+*.orig
+
+# OS files
+Thumbs.db
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,134 @@
+
+# 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, caste, color, 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 email 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
+opensource@shopify.com.
+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
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,66 @@
+# Contributing to Shop Minis Examples
+
+We welcome contributions to the Shop Minis Examples repository! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork locally
+3. Create a new branch for your feature or bug fix
+4. Make your changes
+5. Test your changes thoroughly
+6. Commit your changes with clear, descriptive commit messages
+7. Push your branch to your fork
+8. Submit a pull request
+
+## Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
+2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
+4. Your pull request will be reviewed by maintainers, who may request changes or provide feedback.
+
+## Reporting Issues
+
+If you find a bug or have a feature request, please create an issue in the GitHub repository. When reporting issues, please include:
+
+- A clear and descriptive title
+- A detailed description of the issue or feature request
+- Steps to reproduce the issue (if applicable)
+- Expected behavior
+- Actual behavior
+- Screenshots (if applicable)
+- Your environment (OS, browser, etc.)
+
+## Code Style
+
+Please follow the existing code style in the repository. We recommend:
+
+- Using clear and descriptive variable names
+- Adding comments for complex logic
+- Following the language-specific conventions for the examples
+- Keeping functions small and focused
+
+## Testing
+
+Please ensure that all examples are tested and working before submitting a pull request. Include:
+
+- Unit tests where applicable
+- Integration tests for full examples
+- Documentation on how to run the tests
+
+## Documentation
+
+- Update documentation for any changed functionality
+- Add inline comments for complex code
+- Update the README if you're adding new examples
+
+## Questions?
+
+If you have any questions about contributing, please open an issue and tag it with the "question" label.
+
+Thank you for contributing to Shop Minis Examples! 
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,7 @@
+Copyright 2024-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
diff --git a/README.md b/README.md
@@ -1,38 +1,67 @@
-## This repo is deprecated
+# Shop Minis Examples
 
-shop-minis-runtime was moved to the monorepo in https://github.com/shopify/shop-client/
-This repository is no longer used and maintained.
+This repository showcases examples of Shop Minis.
 
-# shop-minis-runtime
+## About
 
-shop-minis-runtime is responsible for guaranteeing that the context of Minis in development matches the context provided by Shop in production.
+Shop Minis are lightweight, fast-loading components that enable rich shopping experiences. This repository contains various examples demonstrating how to build and integrate Shop Minis into your applications.
 
-## Dependencies
+## Getting Started
 
-Dependencies are provided by Shop itself during production runtime, however, that's not the case when the Mini is executed in a remote setup during development. In those cases, shop-minis-runtime will be the source of truth for which dependencies are available (and which versions they have).
+### Prerequisites
 
-## React context values
+- Node.js (v16 or higher)
+- npm or yarn
 
-React context values are also missing when the Mini is executed in development mode. shop-minis-runtime will expose provider components that mimic the production environment of Shop.
+### Installation
 
-## Metro config
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/Shopify/shop-minis-examples.git
+   cd shop-minis-examples
+   ```
 
-To use the metro config exposed in this package you can use this example `metro.config.js` file:
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
 
-```js
-// metro.config.js
-const { getMinisMetroConfig } = require("@shopify/shop-minis-runtime/metro-config");
+3. Run the examples:
+   ```bash
+   npm start
+   ```
 
-module.exports = getMinisMetroConfig();
-```
+## Examples
 
-## Babel preset
+This repository includes examples for:
 
-To use the babel preset exposed in this package you can use this example `babel.config.js` file:
+- Basic Shop Mini implementation
+- Advanced customization options
+- Integration patterns
+- Best practices for performance
 
-```js
-// babel.config.js
-module.exports = {
-  presets: ["@shopify/shop-minis-runtime/babel-preset"],
-};
-```
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to get started.
+
+Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Support
+
+If you encounter any issues or have questions, please:
+
+1. Check the existing issues in the repository
+2. Create a new issue if your problem hasn't been reported
+3. Reach out to the maintainers
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
+
+## Acknowledgments
+
+Thank you to all contributors who help make Shop Minis better!
+
+---
+
+Copyright 2024-present, Shopify Inc.
