SuperOffice Developer Proposals

Welcome 👋 This repository is the home for ideas, proposals, specifications, and roadmap discussions related to the SuperOffice developer platform and APIs.

Our goal is to collaborate openly with partners, customers, and the developer community on the future of the SuperOffice platform.

---

🚀 Purpose

• Share upcoming roadmaps and planned initiatives
• Collect proposals for new APIs, features, and improvements
• Provide a transparent process for reviewing and discussing changes
• Serve as a historical archive of accepted, rejected, or deferred proposals

This repo is not for bug reports or product support. Please use SuperOffice support or SuperOffice community for that.

---

🔄 Relationship Between Proposals, RFCs, and Specs

• Proposals →
  Early-stage ideas, API suggestions, or improvements.

  • Lightweight, short documents.
  • Used to collect feedback before significant effort is spent.

• RFCs (Requests for Comments) →
  Larger, architectural or cross-cutting design efforts.

  • Broader in scope than a proposal.
  • Often involve multiple APIs, systems, or integrations.
  • Serve as the deep technical discussion space.

• Specifications (Specs) →
  The final, accepted design.

  • Reference-level documentation.
  • Includes request/response formats, data models, workflows, and security considerations.
  • Used by developers as the “source of truth” for implementation.

---

📂 Repository Structure

• /README.md → This file
• /ROADMAP.md → High-level product/API roadmap
• /CONTRIBUTING.md → How to create and review proposals
• /proposals/ → Individual proposals (by year & ID)
• /specs/ → Draft or accepted specifications
• /discussions/ → Optional: outcomes of major debates

---

📝 How to Propose a Change

1. Check for existing proposals in /proposals.
2. If none exist, open a new proposal:
   • Copy the proposal template.
   • Save it under /proposals/YYYY/NNN-title.md (year + sequential ID).
   • Open a pull request.
3. The community and SuperOffice team will review, comment, and refine.
4. Proposals will eventually be marked as:
   • ✅ Accepted
   • ❌ Rejected
   • 🕗 Deferred (not now, maybe later)

For small suggestions, feel free to start with a GitHub Issue or Discussion.

---

📜 Proposal Lifecycle

A proposal goes through these phases:

• Draft → initial idea, open for comments
• In Review → actively being discussed and refined
• Accepted → approved and scheduled for implementation
• Implemented → shipped and documented
• Rejected/Deferred → closed, with rationale recorded

---

🌍 Roadmap

See ROADMAP.md for upcoming initiatives, priorities, and status.

---

🙌 Contributing

We welcome contributions from partners, customers, and developers!
Please read CONTRIBUTING.md to learn how to participate.

---

📄 License

Content in this repository is licensed under Creative Commons Attribution 4.0 International (CC-BY-4.0).

This ensures proposals and specifications remain openly available.