#web-framework #fun #part #type #general #supporting

webframework-core

webframework项目的一部分。它包含了一般类型,这些类型可以被支持库使用。

1个不稳定版本

0.0.2 2018年12月6日

#77 in #supporting


webframework中使用

MIT许可证

12KB
323

Webframework

webframework是一个有趣好用的Rust网页应用程序框架。其主要目标是:安全性、趣味性、速度。它通过结合约定、派生宏和命令行工具来尝试实现这些目标。

要查看完整的示例,请参阅待办事项示例

如果您需要文档,可以在这里找到:待办

完整的文档可以在这里找到:文档

功能

  • 异步
  • 易于使用

更多即将到来! 该项目正在积极开发中。欢迎加入并帮助扩展该框架。

示例

您可以在文档中找到示例。

结构

webframework项目由不同的crate组成

  • webframework:主crate,也是终端用户需要导入的唯一crate。它导出所有需要的内部类型,并导出一个用户可以使用的前缀。
  • webframework-core:内部crate之一,在这里定义了项目的基类型。这主要对项目开发者和想要与这里定义的接口交互的附加crate开发者有用。
  • webframework-derive:这里导出了主要的派生宏。这里定义了用户友好的宏。

将来可能会出现新的crate,但webframework应该是连接一切的crate。

贡献

任何人都可能为webframework项目做出贡献,无论是编写功能、添加测试还是编写文档。报告错误或寻求帮助也是鼓励的。但请记住,这是一个社区项目,意味着你遇到的任何人都是在业余时间做的。所以,请确保保持尊重,并理解可能的较长的回复时间。

代码贡献

代码贡献是添加新功能最欢迎的方式。如果您需要的功能自己可以添加到仓库中,请随时提交新的pull-request或issue。如果您需要帮助,我们会尽力指导或指导您如何实现。

测试贡献

测试非常重要。它们使我们能够确保功能按预期工作,并且在变更后没有出现故障。这就是为什么总是欢迎添加新测试的原因。这可以像一个小单元测试或整个集成测试一样简单。如果您不确定可以测试什么,可以编写一个文档测试!只需选择任何没有测试的方法或类型,并为其编写一个示例,演示它会产生什么效果。如果您需要帮助,我们会引导您。

编写文档

文档允许任何人都能够学习或回顾如何使用这个框架。因此,拥有大量正确的文档非常重要。因此,如果您发现任何错误、遗漏或不清晰的文档,请提出问题,或者更好的是,提出一个拉取请求来修复它。如果您愿意写更多内容,指南或博客文章也受到欢迎。

仓库约定

所有新功能都应通过由bors合并的拉取请求进入master分支。这使我们能够始终保持master分支的构建状态。

Git提交信息应采用祈使句形式,但这不是硬性规定。然而,所有提交信息都必须按照以下格式正确格式化:

<类型 更改>(<更改的系统>): <描述>

允许的类型包括:feat, fix, chore, test, refactor, style, docs

以下是一些示例:

  • feat(webframework):添加新的Frobnarizer组件
  • chore(webframework-core):将变量重命名为一致性Frobnarizer#foo

许可证

webframework项目采用MIT许可证。

依赖项

~7MB
~152K SLoC