Contributing to Openspace

[Openspace-ea]

Thank you for your interest in building an open space ecosystem with us. This guide explains how you can participate, report issues, and contribute code to the Openspace Ecosystem Alliance's open-source projects.

---

本指南中文版见文末「如何参与贡献」部分。

---

1. Introduction

OSEA open-source projects release satellite operating systems, SDKs and development tools under open licenses (software defaults to Apache-2.0). Every contribution — a typo fix, a new feature, or a question — matters. We welcome developers from all backgrounds and experience levels.

2. Ways to Participate

• Discuss — start threads, ask questions and share best practices in [GitHub Discussions](https://github.com/Openspace-ea/community/discussions), organized by categories:
  • Q&A — q-a
  • Ideas & Suggestions — ideas
  • Show & Tell — show-and-tell
  • General — general
• Report bugs / request features — open an [Issue](https://github.com/issues?q=is%3Aissue+is%3Aopen+user%3AOpenspace-ea) with a reproducible description.
• Write code — fork a repo, implement a change and open a Pull Request (PR).
• Improve docs — documentation fixes are always appreciated.

3. Reporting an Issue

When opening an issue, please include:

• A clear, specific title.
• Steps to reproduce (for bugs) or a concrete use case (for features).
• Expected vs. actual behavior.
• Environment details (OS, browser / runtime version) when relevant.

Before creating a new issue, search existing ones to avoid duplicates.

4. Contributing Code

4.1 Fork & Clone

1. Fork the target repository on GitHub.
2. Create a branch with a short, descriptive name: git checkout -b fix/issue-123 or feature/my-feature.

4.2 Commit Convention

Use [Conventional Commits](https://www.conventionalcommits.org/):

feat: add new feature
fix: resolve a bug
docs: update documentation
chore: maintenance work

4.3 Open a Pull Request

• Link the relevant issue (e.g. Closes #12).
• Describe what changed and how it was tested.
• Keep the change focused and reviewable.
• A maintainer will review; respond to feedback and update as needed.

5. Review & Merge

• All PRs go through code review.
• Tests must pass and CI checks should be green before merge.
• Be patient and respectful during review.

6. Code of Conduct

We are committed to a welcoming and respectful community. By participating, you agree to follow the [Code of Conduct](./CODE_OF_CONDUCT.md).

7. License

By contributing, you agree that your contributions are licensed under the project's license (Apache-2.0 by default for OSEA software), and you represent that you are authorized to do so.

---

如何参与贡献（中文版）

欢迎加入 OSEA 开源生态的建设。本指南介绍你如何参与讨论、提交问题以及为联盟开源项目贡献代码。

1. 简介

OSEA 开源项目以开放许可证（软件默认 Apache-2.0）发布卫星操作系统、SDK 与开发工具。无论是修正一处拼写、新增一个特性，还是提出一个问题，你的每一份贡献都很重要。我们欢迎不同背景与经验水平的开发者。

2. 参与方式

• 社区讨论 — 在 [GitHub Discussions](https://github.com/Openspace-ea/community/discussions) 发起话题、提问答疑、分享最佳实践，按主题分为：
  • 问答互助 — q-a
  • 想法建议 — ideas
  • 成果展示 — show-and-tell
  • 综合讨论 — general
• 问题反馈 / 功能建议 — 提交 [Issue](https://github.com/issues?q=is%3Aissue+is%3Aopen+user%3AOpenspace-ea)，附上可复现的描述。
• 贡献代码 — Fork 仓库、实现改动并提交 Pull Request（合并请求）。
• 完善文档 — 文档类修正同样受欢迎。

3. 提交 Issue

提交 Issue 时请尽量包含：

• 清晰、具体的问题标题。
• 可复现步骤（针对 Bug）或具体使用场景（针对功能建议）。
• 预期行为与实际问题现象。
• 相关环境信息（操作系统、浏览器 / 运行时版本等）。

提交前先搜索是否已有相似 Issue，避免重复。

4. 贡献代码

4.1 Fork 与 Clone

1. 在 GitHub 上 Fork 目标仓库。
2. 创建简短、描述清晰的分支名，例如 git checkout -b fix/issue-123 或 feature/my-feature。

4.2 提交信息规范

推荐使用 [Conventional Commits](https://www.conventionalcommits.org/) 格式：

feat: 新增特性
fix: 修复问题
docs: 更新文档
chore: 维护性改动

4.3 提交 Pull Request

• 关联相关 Issue（例如 Closes #12）。
• 说明改了什么以及如何测试。
• 保持改动聚焦、便于审查。
• 维护者会进行评审，请根据反馈及时调整。

5. 评审与合并

• 所有 PR 均需经过代码评审。
• 测试需通过，CI 检查通过后方可合并。
• 评审过程中请保持耐心与礼貌。

6. 行为准则

我们致力于营造开放、友善、相互尊重的社区氛围。参与即表示同意遵守 行为准则。

7. 许可证

通过提交贡献，你同意你的贡献遵循项目所用许可证（OSEA 软件默认 Apache-2.0），并保证你具备相应授权。