Looking for Content Contributions (Checklists, Manuals, Charts, …)

未关闭
  • 哪里不对？
#8 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
领域
content, documentation

调研方向

将 app/src/main/assets/ 中现有的 Markdown 文件作为模板进行查看，然后选择适合所请求的检查清单、手册、图表或参考文档的内容。将 Markdown 或 PDF 文件放入所需目录，并为检查清单使用以飞机命名的子目录。当内容符合结构、命名、格式和许可要求，并已在 pull request 中提交时，即表示完成。

由索引模型根据 Issue 内容生成。

描述

documentation enhancement good first issue help wanted priority: low ready for review testing

We are currently seeking additional content contributions for this application.

Scope of Requested Content

We welcome the creation and improvement of the following materials:

  • Checklists
  • Manuals
  • Charts
  • Other relevant reference documentation suitable for in-app use

Supported File Formats

  • ✅ Markdown (.md) — preferred
  • ✅ PDF (.pdf)

Formatting Guidelines

  • Use existing Markdown files in the repository as a reference and template
  • Example files and fill-in templates will be provided at a later stage
  • Core conventions:
    • ## headings define sections / containers
    • - [ ] denotes checklist items

Directory Structure

All files must be placed in the following directory:

app/src/main/assets/
Checklist Storage

Checklists must reside in a subdirectory named after the respective aircraft:

app/src/main/assets/Checklists/<Aircraft-Name>/

Example:

app/src/main/assets/Checklists/F-14B/

Review and Quality Improvements

  • Existing checklists should be reviewed and validated for completeness
  • Corrections, structural improvements, and original enhancements are explicitly encouraged
  • Contributors are welcome to refine wording, optimize sequencing, and add missing or clarifying steps

Licensing Requirements

All contributed material must be:

  • Original work, or
  • Derived from public-domain sources (e.g. FAA publications or unrestricted U.S. Government documents), or
  • Used with permission of the copyright holder

Do not submit content sourced from:

  • Manuals with distribution restrictions (e.g. “Official Use Only”, Distribution Statement B or C)
  • Publications labeled “All Rights Reserved”

Contribution Process

  1. Add new content or improve existing files
  2. Review and, where possible, validate existing checklists
  3. Adhere strictly to the defined folder structure
  4. Commit changes and submit a Pull Request

General Guidelines

  • Maintain clear structure and consistent naming
  • Prefer Markdown for optimal in-app readability
  • Ensure all content complies with the stated licensing requirements
主要语言
Kotlin
星标
45
派生
4
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

arn-c0de/InteractiveChecklists 的其他 Issue

查看 arn-c0de/InteractiveChecklists 的全部 Issue

相似的 Issue

更多 Kotlin Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。