Skip to content

Commit

Permalink
Merge pull request #161 from ton-blockchain/add-pr-comment-workflow
Browse files Browse the repository at this point in the history
chore: add automated pr comment workflow
  • Loading branch information
thekiba authored Feb 28, 2025
2 parents 0cebe4f + 4657473 commit 3a735ff
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 0 deletions.
63 changes: 63 additions & 0 deletions .github/workflows/comment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# TON Connect Integration Review Process

Thank you for contributing to the TON ecosystem\! To ensure a seamless experience for users and maintain high-quality integrations, we review all wallet submissions thoroughly. Below is an overview of our process:
---

### **Why We Audit Integrations**

We audit integrations to:

* Ensure the **best possible experience** for TON ecosystem users.
* Confirm that TON Connect is implemented securely, reliably, and in alignment with our specifications.

---

### **Integration & Audit Process**

Follow these steps to submit your wallet for inclusion in the TON Connect list:

1. **Review Documentation**:
* Study our [**TON Connect Documentation & Specifications**](https://docs.google.com/document/d/1Z2dWpn-p7net3fE1gBJlyNUeTN5nZaUC2g7lUt4t2TY/edit?usp=sharing).
* Implement TON Connect in your wallet using the guidelines provided.
2. **Self-Test Using Checklist**:
* Validate your integration against our [**Checklist of Tests**](https://www.notion.so/theopenplatform/Checklist-of-tests-1571e095988680828da8c2d57e5bf567).
* Ensure all functionalities (e.g., connection, transaction signing, error handling) work as expected.
3. **Review Wallet Manifest Requirements**:
* Familiarize yourself with the [**wallet manifest format and requirements**](https://github.com/ton-blockchain/wallets-list/?tab=readme-ov-file#entry-format).
* Ensure your wallet manifest follows the specified format with all required fields.
4. **Submit a PR**:
* Open a Pull Request (PR) to add your wallet to the TON Connect registry.
5. **Notify Us**:
* Reach out to [**@kawaiinya**](https://t.me/kawaiinya) on Telegram to confirm your submission.
* We’ll create a dedicated Telegram chat to coordinate the audit.

---

### **Audit Process Details**

* **Initial Review**:
* Our team will schedule an audit and share a report.
* If no issues are found, your PR will be merged promptly.
* **Revisions & Re-Audits**:
* If issues arise, we’ll provide feedback. Once fixes are implemented, we’ll re-audit.
* This cycle continues until all requirements are met.

---

### **Audit Timeline**

* **Typical Duration**: \~3 working days (*after the audit begins*).
* **Current Backlog**: Due to high demand (15+ wallets in the queue), audits may be delayed.
* We appreciate your patience and will notify you once your audit is scheduled.

---

### **Resources**

* [**TON Connect Specifications**](https://docs.google.com/document/d/1Z2dWpn-p7net3fE1gBJlyNUeTN5nZaUC2g7lUt4t2TY/edit?usp=sharing)
* [**Integration Checklist**](https://www.notion.so/theopenplatform/Checklist-of-tests-1571e095988680828da8c2d57e5bf567)

---

We’re excited to collaborate with you and welcome your wallet to the TON ecosystem\! 🚀
For questions, please contact [**@kawaiinya**](https://t.me/kawaiinya) on Telegram.
20 changes: 20 additions & 0 deletions .github/workflows/pr-comment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: PR Auto Comment

on:
pull_request_target:
types: [opened]

permissions:
pull-requests: write

jobs:
add-comment:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Comment PR
uses: thollander/actions-comment-pull-request@v3
with:
file-path: .github/workflows/comment.md

0 comments on commit 3a735ff

Please sign in to comment.