diff --git a/README.md b/README.md index abd39835..10708f5c 100644 --- a/README.md +++ b/README.md @@ -31,17 +31,35 @@ ## 功能列表 -### 背单词 - -根据记忆曲线自动计算学习单词,并通过默写加深记忆;提供了音标、发音(美音、英音)、例句、短语、近义词、同根词、词源、错误统计等功能 +### 单词练习 + +- 三种输入模式:跟打 / 复习 / 默写 +- 智能模式:记忆曲线自动计算学习单词,并通过默写加深记忆 +- 自由模式:不受限制,自行规划 +- 提供音标、发音(美音、英音)、例句、短语、近义词、同根词、词源、错误统计等功能 ### 背文章 + +- 内置经典教材书籍,也可自行添加、导入文章,提供一键翻译、译文对照功能 +- 跟打 + 默写双模式,逐句输入,自动发音,让背诵更高效 +- 支持边听边默写,强化记忆 -内置经典教材书籍,练习和背诵文章,逐句输入,自动发音。可以自行添加、导入文章,提供一键翻译、译文对照功能 ### 收藏、错词本、已掌握 -学习单词时输入错误会自动添加到错词本,方便后续复习。也可以添加到已掌握,以后再遇到这个词会自动跳过,同时也可以将其添加到收藏中,以便巩固复习 +- 学习单词时输入错误自动添加到错词本,方便后续复习 +- 可主动添加到已掌握,后续学习时自动跳过 +- 可主动添加到收藏中,以便巩固复习 + +### 高度自由 +- 丰富的键盘音效 +- 可自定义快捷键 +- 高度定制化的设置选项 + +### 简洁高效 +- 简洁设计,现代化UI,无广告 +- 界面清爽,操作简单 +- 不强制关注任何平台 ### 词库 @@ -64,4 +82,16 @@ 目前项目处于开发初期,新功能正在持续添加中,如果你对软件有任何功能与建议,欢迎在 `Issues` 中提出 如果你也喜欢本软件的设计思想,欢迎提交 `pr`,非常感谢你对我们的支持! +## 贡献指南 +[贡献准则](/docs//CONTRIBUTING.md) + +如果您对本项目感兴趣,我们非常欢迎参与到项目的贡献中,我们会尽可能地提供帮助 + +在贡献前,希望您阅读 Issue #57 了解我们目前的开发计划,我们希望您能参与到"计划中"的工作亦或者 Issue 区 Label 为 "Help Wanted" 的工作,我们也非常欢迎您实现自己的想法。 + +如果您确定了想要参与的工作,希望在有基本进展后提交 draft pr,我们可以在 draft pr 上进行讨论,也有利于听取其他 collaborator 的意见。 + +再次感谢您对项目的贡献!🎉 + + diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 00000000..00310762 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# 开源代码贡献准则 + +## PR 来源 + +- 我们会在 GitHub 上将需要完成的 feature 和修复的 bug 标记为 "Help Wanted" +- 用户在用户社群(在项目官方部署的 footer 中有二维码)提出的需求和 bug +- 根据大家对项目的理解和兴趣,认为需要做的 feature 和修复的 bug + +## 在开始做 PR 之前 +- 在 **开发者社群或 issue 区** 进行讨论,确认这个 PR 符合项目需求,并考虑对现有代码和未来计划的影响 +在 GitHub 上创建相关的 issue(已有 issue 则无须创建),并进行回复。尽可能在 issue 描述了问题、解决方案、相关细节和贡献者预期的工作,方便大家进行讨论 +- 确认开始 issue 后,尽可能在一周内解决(相对复杂的 issue 除外),以免 PR 长期无法推进,其他开发者也无法参与 +在 PR 过程中 +- 在开始 coding 后,尽早提出一个 draft PR,方便其他开发者参与讨论,给出建议和帮助 +遇到任何技术问题和实现路线问题,可以在 开发者社群或 issue 区 进行讨论。确保 PR 满足项目的开发规范和质量标准,经过充分测试和文档支持 +- 在 PR 中友好协作,回应 Code Review。接受反馈并进行改进,遵守代码风格和注释规范,确保代码的可读性和可维护性 +其他人也可以对 PR 进行 Review,帮助发现代码中的问题,提出自己的建议和想法 +不需要担心自己的 pr 没有完整的覆盖掉所有 corner case 或者是否会与项目的其他功能产生冲突(对于 new contributor 来说,很难有时间完整理解项目所有代码和逻辑),只需要尽自己所能去实现,我们会在 review 的过程中一起讨论和完善。 我们都贡献自己擅长的部分就可以打造一个优秀 pr 和更好的 TypeWords! + +## 完成 PR 后 +- 标记相关 issue 为完成。确保代码被合并到主分支,并在生产环境中经过充分测试和部署 +- 如果是用户社群的相关需求,可以在社群内对用户进行回复 + +## 行为准则 + +- 尊重所有贡献者,不论其技术水平、经验、性别、性取向、种族、宗教信仰或国籍 +- 保持开放的心态,愿意接受其他人的批评和建议,并根据反馈进行改进 +- 提交有价值的贡献,符合项目需求并遵守项目的开发规范和质量标准 +- 不要在 PR 或讨论中使用不礼貌或侮辱性的语言,不要发布任何垃圾或攻击性的内容 +- 遵守代码行为准则,不要进行不道德或不法的行为,如抄袭、篡改他人代码、恶意破坏等 +- 避免进行灌水式的讨论或评论,尽量保持话题与项目相关,并尊重他人的意见和观点 +- 遵守相关法律法规和 GitHub 平台的规定,不发布含有违法、政治或淫秽内容的 PR 或评论 + +## 反馈 +如有任何问题或建议,请随时在 issue 区或者群内提出,我们将及时解决。同时,欢迎参与项目的讨论和开发,共同打造更加优秀的开源项目! \ No newline at end of file