Skip to content

docs: translate README into Spanish #475

Description

@AbdulmalikAlayande

🎯 Context & Objective

Sorokeep's README is English-only. A Spanish translation broadens reach into the large Latin American Stellar/Soroban developer community.

📝 Implementation Plan

  1. Step 1: Create README.es.md with a full translation of README.md (all sections: Why This Exists, Features, Install, Quick Start, Commands, Alerting, How It Works, FAQ, Roadmap, Contributing).
  2. Step 2: Keep all code blocks, command names, and flag names untranslated (only prose is translated).
  3. Step 3: Add a language switcher line at the top of both README.md and README.es.md linking to each other.

🧪 Test-Driven Development (TDD) Requirements

🚨 IMPORTANT: We enforce strict Test-Driven Development. You must write your tests before implementing the logic.
Your Pull Request will not be accepted without comprehensive tests.

  • Setup Test Environment: Create or locate the relevant test file.
  • Write Failing Tests First: Based on the Acceptance Criteria, write your tests.
  • Implementation: Implement the logic to make the tests pass.
  • Edge Cases: Ensure you have tested edge cases and failure modes.

Specific Test Criteria:

  • README.es.md covers every section present in README.md — no sections dropped or left in English.
  • Reviewed by a native or fluent Spanish speaker before merge (note this in the PR description).

🛠️ Technical Notes

This file will go stale as README.md changes — note in the PR that translation maintenance is an ongoing commitment, not a one-time task, and consider flagging in the PR whether the contributor is willing to maintain it.

📂 Scope — Files You May Touch

Create:

  • README.es.md

Edit (only what's described above — don't touch unrelated parts of these files):

  • README.md — add the language-switcher line only

Do not touch:

  • src/, tests/, README.pt.md, README.zh.md — coordinate switcher links via the language-switcher line only, don't edit the content of other translation files

If your solution seems to require touching something outside this list, stop and comment on the issue before proceeding — the scope may need to change, but that's a maintainer decision.

📚 Learning Resources & References

✅ Acceptance Criteria

  • README.es.md covers every section of README.md.
  • Reviewed by a native/fluent Spanish speaker before merge.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave programphase-14Phase 14: Documentation & Contributor Experiencestellar-waveStellar Wave Program

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions