# How to Add an Algorand Open-Source Repo to AlgoScan

Add repositories by proposing a focused Pull Request to `tracked_repos.json`. Keep each PR reviewable, verifiable, and scoped to high-signal Algorand open-source software.

---

## 1) Prepare your candidate repositories

- Confirm the repo is actively related to the Algorand ecosystem (protocol tooling, SDKs, infrastructure, wallets, indexers, governance tooling, analytics, developer tooling, education, etc.).
- Validate ownership and canonical source — official org repos are preferred over forks.
- Exclude mirrors, archived repos, spam, and projects already represented by an upstream canonical repo.

## 2) Fork and branch with a clean change set

1. Fork `NT-Nova/AlgoScanArtifacts`.
2. Create a small, focused branch — e.g. `add-tracked-repos-algorand-wallets`.
3. Edit only `tracked_repos.json` unless a maintainer requested additional files.

## 3) Edit `tracked_repos.json` carefully

- Preserve existing JSON structure and ordering conventions used in the file.
- Add entries with exact `owner/name` values; avoid shorthand or ambiguous aliases.
- Do not reformat unrelated sections or reorder existing entries unnecessarily.
- Run local JSON validation before committing to ensure syntactic correctness.

## 4) Open a high-quality Pull Request

Use a precise title — for example: **Add tracked repos for Algorand wallet tooling**.

Include in the PR description:

| Section            | What to provide                                                               |
| ------------------ | ----------------------------------------------------------------------------- |
| **What was added** | List each `owner/name`                                                        |
| **Why it belongs** | One concise reason per repo                                                   |
| **References**     | Official docs, release notes, org pages, ecosystem links                      |
| **Edge cases**     | Renamed repo, archived predecessor, migration path (if any)                   |
| **Validation**     | Confirm `tracked_repos.json` is valid JSON and no unrelated changes were made |

## 5) Follow maintainer workflow etiquette

- Keep discussion in a single PR thread and respond to review comments with concrete updates.
- Prefer follow-up commits over force-push during active review (unless requested).
- If scope grows, split into multiple PRs by category to reduce review overhead.
- After approval, let maintainers merge unless repository policy says otherwise.

---

## PR Quality Checklist

| Check                                                    | Why it matters                 |
| -------------------------------------------------------- | ------------------------------ |
| Only relevant Algorand open-source repos were added      | Keeps AlgoScan high-signal     |
| No duplicate, archived, or low-signal entries introduced | Avoids stale mirrors and noise |
| JSON validates and file formatting remains clean         | Prevents merge blockers        |
| PR description includes rationale and source references  | Makes maintainer review faster |