Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (69 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

100 lines (69 loc) · 3.04 KB
Raw

Contributing to Future Work Platform

English | 简体中文

English

Thank you for helping improve Future Work Platform. This repository is an open-source prototype, so contributions should keep the local demo runnable, make production limitations explicit, and avoid introducing real personal or enterprise data.

Before You Start

  • Use an issue or discussion to align on large features, schema changes, or changes that affect multiple portals.
  • Keep pull requests focused. Separate unrelated refactors from behavior changes.
  • Never commit real credentials, production tokens, personal data, or confidential documents.
  • Treat the values in .env.example files and the README as local demo values only.

Local Setup

./start-local-demo.sh
./verify-local-demo.sh

The README contains the portal URLs and local demo tokens.

Before Opening a Pull Request

Run the release-oriented verification script:

./verify-open-source.sh

Please also confirm:

  • New behavior is documented where users or integrators will notice it.
  • New environment variables have safe placeholders in the relevant .env.example file.
  • Generated output, local .env files, dependency directories, and logs are not included.
  • New assets, screenshots, and documents are cleared for public redistribution.
  • Dependency additions are compatible with distribution under the repository's MIT license and are reflected in release notices when needed.

Pull Request Notes

Describe the problem, the chosen solution, verification performed, and any known production-hardening follow-up. Screenshots are welcome for visible UI changes.

Reporting Security Issues

Do not open a public issue for a suspected vulnerability. Follow SECURITY.md.

简体中文

感谢你参与改进 Future Work Platform。本仓库是一个开源原型，因此贡献内容需要保持本地 Demo 可运行，如实说明生产化边界，并避免引入真实个人或企业数据。

开始之前

  • 大功能、数据库结构调整或影响多个端的改动，请先通过 Issue 或 Discussion 对齐。
  • Pull Request 应聚焦单一主题，不要将无关重构与功能修改混在一起。
  • 不要提交真实密钥、生产 token、个人数据或保密文档。
  • .env.example 与 README 中的固定值仅用于本地演示。

本地启动

./start-local-demo.sh
./verify-local-demo.sh

各端入口和本地演示 token 请查看 README。

提交 Pull Request 前

请运行：

./verify-open-source.sh

同时确认：

  • 用户或集成方可感知的新行为已经补充文档。
  • 新环境变量已经在相应 .env.example 中提供安全占位值。
  • 没有提交生成产物、本地 .env、依赖目录或日志。
  • 新增素材、截图和文档拥有公开再分发权。
  • 新依赖允许与本仓库 MIT 许可证共同分发，必要时补充发布声明。

安全问题

疑似安全漏洞不要通过公开 Issue 报告，请遵循 SECURITY.md。