diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 284093c..8b5300b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to XOps +# Contributing to TODO: Project Name ⭐ First off, thank you for considering contributing to this project! ⭐ @@ -68,11 +68,7 @@ What we expect: ### Prerequisites -- Node.js ≥ 20 -- npm - -No accounts, secrets, or wallets are needed — everything defaults to `mode: dry-run` and the -checks run fully offline. +TODO: List prerequisites specific to your project ### Setup @@ -83,23 +79,25 @@ checks run fully offline. 2. **Clone Your Fork** ```bash - git clone https://github.com/YOUR_USERNAME/XOps.git - cd XOps + git clone https://github.com/YOUR_USERNAME/TODO.git + cd TODO ``` 3. **Add Upstream Remote** ```bash - git remote add upstream https://github.com/AOSSIE-Org/XOps.git + git remote add upstream https://github.com/AOSSIE-Org/TODO.git ``` 4. **Install Dependencies** ```bash npm install + # or yarn install + # or pnpm install ``` -5. **Run the Checks** +5. **Run the Project** ```bash - npm run check + npm run dev ``` ## 🔄 Development Workflow @@ -123,13 +121,12 @@ git checkout -b fix/your-bug-fix ### 3. Test Your Changes +TODO: Add project-specific testing instructions + ```bash -npm run check # lint + layer-boundary check + dependency-count check + tests -# or individually: -npm run lint npm test -npm run check:boundary -npm run check:deps +# or +npm run lint ``` ### 4. Commit Your Changes @@ -226,9 +223,7 @@ Steps to test the changes ## 📝 Code Style Guidelines -See [AGENTS.md](./AGENTS.md) for the project's authoritative, non-negotiable rules — the layer -boundary between `src/core`/`src/adapters` and the drivers, the dependency-count cap, and the -idempotency conventions. CI enforces these on every push. +TODO: Add project-specific code style guidelines ### General Guidelines @@ -239,12 +234,17 @@ idempotency conventions. CI enforces these on every push. - Avoid code duplication - Avoid unnecessary complexity and minor over-optimization -### TypeScript +### JavaScript/TypeScript - Use ES6+ syntax - Prefer `const` over `let`, avoid `var` - Use arrow functions where appropriate - Follow ESLint rules +### Python +- Follow PEP 8 style guide +- Use type hints where applicable +- Write docstrings for functions/classes + ## 🔧 Debugging Pre-commit Hooks Pre-commit hooks help maintain code quality by running automated checks before each commit. This section helps you troubleshoot common issues. @@ -538,4 +538,4 @@ If you encounter issues not covered here: - Check for existing PRs before starting to avoid duplication, as there might PRs that didn't mention the related issue -Thank you for contributing to XOps! Your efforts help make this project better for everyone. 🚀 +Thank you for contributing to TODO! Your efforts help make this project better for everyone. 🚀 diff --git a/MAINTAINERS.md b/MAINTAINERS.md index ee0dec0..6035f6f 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -6,24 +6,20 @@ This document lists the individuals fulfilling the key roles of [Maintainer](htt > **Note:** If multiple contributors are fulfilling a role in a single repository, please include and fill out the extra columns to clarify responsibilities (e.g., `Project / Feature Idea`, `Area / Focus`, and `Proposal / Discussion Link` for Ideators; `Area / Focus` for Mentors and Maintainers). If there is only one person for a role, do not add these columns. - ## Ideators | Name | GitHub Username | Discord Username | Project / Feature Idea | Area / Focus | Proposal / Discussion Link | | ---- | --------------- | ---------------- | ------------------------------- | -------------------- | ------------------------------------------- | -| Karun Pacholi | @kpj2006 | @karunpacholi0408 | XOps | x402 implementation & Devops | [Discussions](https://discord.com/channels/1022871757289422898/1458764598562783323) | +| TODO | @username | @discord_user | Context-First AI Infrastructure | AI Workflow & Skills | [Discussion](https://github.com/AOSSIE-Org) | ## Mentors | Name | GitHub Username | Discord Username | Area / Focus | | ---- | --------------- | ---------------- | ----------------------------------- | -| Bruno | @Zahnentferner | @b.wp | whole Project Guidance & PR Reviews | -| Madhav | @M4dhav | @m4dhav | co-mentoring & project guidance | -| Bhavik | @bhavik-mangla | @bhav_x | co-mentoring & project guidance | +| TODO | @username | @discord_user | whole Project Guidance & PR Reviews | ## Maintainers | Name | GitHub Username | Discord Username | Area / Focus | | ---- | --------------- | ---------------- | -------------------------------- | -| Bruno | @Zahnentferner | @b.wp | Repository Maintenance, technical oversight & Merging | -| Karun Pacholi | @kpj2006 | @karunpacholi0408 | Overall maintenance, and pull request reviews | +| TODO | @username | @discord_user | Repository Maintenance & Merging | diff --git a/PRIVACY.md b/PRIVACY.md index 932410e..3533c0d 100644 --- a/PRIVACY.md +++ b/PRIVACY.md @@ -2,53 +2,114 @@ ## Introduction -XOps is a GitHub Action, not a hosted application or service. It runs entirely inside the -adopting repository's own GitHub Actions runner. The maintaining project (AOSSIE) operates no -backend, database, or analytics endpoint for XOps, and receives no data from any run of it. +[TODO: Project Name] (the App) is committed to protecting your privacy and providing a transparent and user-friendly experience. -## What XOps Processes +This Privacy Policy explains how the App handles information when you use it. -When a workflow invokes the action, it processes only what that workflow's own configuration and -repository events provide — for example, an issue/PR comment, a recipient identifier, and an -amount. This data: +The App follows a privacy-conscious and local-first approach. +It aims to collect and process only the information necessary to provide its functionalities. +Where possible, information is processed and stored locally on your device rather than being transmitted to or stored on remote servers. -- is read from and written back to the adopter's own GitHub repository (workflow inputs/outputs, - PR/issue comments, `GITHUB_OUTPUT`); -- is never transmitted to AOSSIE or any server AOSSIE operates, because none exists in the - default flow; -- may, depending on the configured `settlement.mode`, be sent to a public blockchain RPC endpoint - or a third-party x402 facilitator that the *adopter* configures (e.g. `x402.org/facilitator`). - Any data sent to those third parties is governed by their own policies, not this one. -The default mode is `dry-run`: no network calls, no secrets, and nothing leaves the workflow run. +## Information and Permissions + +Depending on the features you use and the permissions you grant, the App may access information such as: + +* Information you provide directly to the App +* Information generated through your use of the App +* Device information or permissions required for specific features +* [TODO: Add any project-specific information, such as location, health data, contacts, files, etc.] + +The information accessed by the App is used only for the purposes described in this Privacy Policy and to provide the functionality of the App. + +You can deny or revoke permissions at any time through your device settings. +Some features may not work if the permissions required for those features are not granted. + ## Data Storage -XOps does not store data on any server it operates — it has none. Any state (idempotency keys, -receipts) lives only in the adopter's own repository or CI logs, under the adopter's control. +The App is designed to minimize the storage and transmission of personal information. + +[TODO: choose the applicable option:] +[-- TODO: Option A: Begin] +All information is stored locally on your device and is not uploaded to or maintained on any remote server. +[-- TODO: Option A: End] + +[-- TODO: Option B: Begin] +Any information stored in remote servers is limited to what is necessary for the App's functionality. +The App stores the following information in servers: +* [TODO: which information is stored, where it is stored and why] +* [TODO: which information is stored, where it is stored and why] +[-- TODO: Option B: End] + ## Data Sharing -XOps does not sell, share, or use any data for advertising. The only external calls it can make -are the ones explicitly configured by the adopter (an RPC endpoint or facilitator URL) to -complete a settlement the adopter requested. +The App does not sell your personal information. + +The App does not use personal information for targeted advertising. + +[TODO: choose the applicable option:] +[-- TODO: Option A: Begin] +No information is shared with any third parties. +[-- TODO: Option A: End] + +[-- TODO: Option B: Begin] +The App may communicate with third-parties when required to provide specific features. +Any information transmitted to such services is limited to what is necessary for the App's functionality. +The following is a list of third parties and the information that may be shared with them: +* [TODO: Third Party Name]: [TODO: information that is shared with that third party and for which feature] +* [TODO: Third Party Name]: [TODO: information that is shared with that third party and for which feature] + +Where a third-party processes information, its handling of that information is governed by its own privacy policy and terms of service. +[-- TODO: Option B: End] + + +## Data Security + +The App aims to minimize privacy and security risks by limiting unnecessary data collection and, +where possible, processing information locally on your device. -## On-Chain Data +However, no method of electronic storage or transmission can be guaranteed to be completely secure. Users are also responsible for maintaining the security of their devices and for protecting any information they choose to export, share, or otherwise make available. -When `settlement.mode` is not `dry-run`, XOps constructs and may broadcast a transaction on a -public blockchain (currently Base Sepolia). Transactions on a public blockchain are, by their -nature, permanently public and visible to anyone — this is inherent to the technology, not a -choice made by this project. -## Security +## Data Deletion + +Where information is stored locally, you can generally remove it by using the App's available data-clearing features, +clearing the data through your device settings, or uninstalling the App. + +[TODO (add if applicable): Where information is stored on servers, you may request deletion of that information by TODO.] + + +## Data Export + +The App may allow you to export information. Exported files are created and stored on your device, +and you are responsible for protecting any files you choose to export or share. + + +## Children's Privacy + +The App is not intended to knowingly collect personal information from children where such collection is prohibited by applicable law. + +[TODO: If the project has specific age requirements, describe them here.] + + +## Free Access + +The App aims to keep its core functionality accessible to users without +requiring mandatory subscriptions or payments to unlock essential features. + +[TODO: If the project has paid features, subscriptions, or other monetization, describe them clearly here.] -Secrets (e.g. a gas wallet key) are supplied and held by the adopter in their own GitHub Secrets, -never by AOSSIE. See [AGENTS.md](AGENTS.md) for the project's custody model. ## Changes to This Privacy Policy -We may update this Privacy Policy as the project evolves. Updates will be published in this file. +We may update this Privacy Policy from time to time to reflect changes to the App, its functionality, or applicable legal requirements. + +Any updates will be made available wherever this Privacy Policy is published. ## Contact Us -Questions about this policy: [contact@aossie.org](mailto:contact@aossie.org) +If you have any questions or concerns about this Privacy Policy or the App's privacy practices, please contact us at: + +[contact@aossie.org](mailto:contact@aossie.org) diff --git a/checklist-status.json b/checklist-status.json index 2d7ab73..2f131c4 100644 --- a/checklist-status.json +++ b/checklist-status.json @@ -3,7 +3,7 @@ "label": "Best Practices", "message": "0%", "schema": "aossie-best-practices-v1", - "updated": "2026-08-25", + "updated": "2026-05-25", "met": 0, "total": 49, "percent": 0,