跳至内容

帮助 Typer - 获取帮助

你喜欢 **Typer** 吗？

你想帮助 Typer、其他用户和作者吗？

或者你想获得 **Typer** 的帮助？

有很多简单的方法可以帮助（其中一些只需要点击一两次）。

也有很多方法可以获得帮助。

订阅时事通讯

你可以订阅（不常更新的）FastAPI 及其朋友 时事通讯，以了解有关以下内容的最新信息

  • 关于 FastAPI 及其朋友（包括 Typer 🚀）的新闻
  • 指南 📝
  • 功能 ✨
  • 重大变更 🚨
  • 技巧和窍门 ✅

在 GitHub 上为 **Typer** 加星

你可以在 GitHub 上为 Typer “加星”（点击右上角的星形按钮）：https://github.com/tiangolo/typer。

通过添加星标，其他用户将更容易找到它，并看到它已经对其他人有用。

关注 GitHub 仓库以获取发行版

你可以在 GitHub 上“关注” Typer（点击右上角的“关注”按钮）：https://github.com/tiangolo/typer。

在那里你可以选择“仅限发行版”。

通过这样做，你将在每次发布 **Typer** 的新版本（包含错误修复和新功能）时收到通知（在你的电子邮件中）。

与作者联系

你可以与 我（Sebastián Ramírez / tiangolo），作者联系。

你可以

  • 关注我在 **GitHub** 上.
    • 查看我创建的其他可能对你有帮助的开源项目。
    • 关注我，以便在我创建新的开源项目时收到通知。
  • 关注我在 **Twitter** 上.
    • 告诉我你如何使用 Typer（我很乐意听到你的反馈）。
    • 在我发布公告或发布新工具时收到通知。
  • 关注我在 **Linkedin** 上.
    • 在我发布公告或发布新工具时收到通知（尽管我更常使用 Twitter 🤷‍♂）。
  • 阅读我在 Dev.to 或 Medium 上撰写的文章（或关注我）。
    • 阅读其他想法、文章，并了解我创建的工具。
    • 关注我，以便在我发布新内容时收到通知。

在 Twitter 上分享 **Typer**

分享你对Typer的喜爱，并告诉我和其他人你为什么喜欢它。

我很想知道Typer是如何被使用的，你最喜欢它的哪些功能，你在哪些项目/公司中使用它等等。

在 GitHub 上帮助他人解答问题

你可以尝试在以下地方帮助他人解答问题：

很多情况下，你可能已经知道这些问题的答案。🤓

请记住，最重要的一点是：尽量保持友善。人们带着自己的沮丧而来，很多时候他们不会以最好的方式提问，但请尽你所能保持友善。🤗

我们的目标是让Typer社区成为一个友善和欢迎的社区。同时，不要接受对他人进行欺凌或不尊重的行为。我们要互相照顾。

以下是如何帮助他人解答问题（在讨论区或问题中）：

理解问题

  • 检查你是否理解提问者的目的和用例。

  • 然后检查问题（绝大多数是问题）是否清晰。

  • 很多情况下，提出的问题是关于用户想象中的解决方案，但可能存在更好的解决方案。如果你能更好地理解问题和用例，你就可以提出更好的替代解决方案。

  • 如果你不理解问题，请要求提供更多细节。

重现问题

对于大多数情况和大多数问题，都与提问者的原始代码有关。

很多情况下，他们只会复制一小段代码，但这不足以重现问题。

  • 你可以要求他们提供一个最小、可重现的示例，你可以复制粘贴并本地运行，以查看他们看到的相同错误或行为，或者更好地理解他们的用例。

  • 如果你觉得太慷慨，你可以尝试自己创建这样的示例，只需根据问题的描述即可。请记住，这可能需要很多时间，最好先要求他们澄清问题。

提出解决方案

  • 在能够理解问题后，你可以给他们一个可能的答案。

  • 在很多情况下，理解他们的根本问题或用例会更好，因为可能存在比他们尝试的方法更好的解决方法。

请求关闭

如果他们回复，很有可能你已经解决了他们的问题，恭喜你，你是英雄！🦸

  • 现在，如果这解决了他们的问题，你可以要求他们

    • 在 GitHub Discussions 中：将评论标记为答案。
    • 在 GitHub Issues 中：关闭问题**。

关注 GitHub 仓库

你可以在 GitHub 上“关注” Typer（点击右上角的“关注”按钮）：https://github.com/tiangolo/typer。

如果你选择“关注”而不是“仅关注发布”，你将在有人创建新问题或提问时收到通知。你还可以指定只希望收到关于新问题、讨论、PR 等的通知。

然后你可以尝试帮助他们解决这些问题。

提问

你可以在 GitHub 仓库中创建新问题，例如

  • 提出一个问题或询问一个问题。
  • 建议一个新的功能。

注意：如果你这样做，那么我会要求你也帮助其他人。😉

审查 Pull Requests

你可以帮助我审查其他人提交的 Pull Requests。

再次，请尽力保持友善。🤗

以下是你需要牢记的内容以及如何审查 Pull Request

理解问题

  • 首先，确保你理解 Pull Request 试图解决的问题。它可能在 GitHub Discussion 或 Issue 中有更长的讨论。

  • 也有可能 Pull Request 实际上并不需要，因为问题可以通过其他方式解决。然后你可以建议或询问有关该问题。

不要担心风格

  • 不要太担心提交消息风格之类的事情，我会手动压缩和合并，自定义提交。

  • 也不要担心风格规则，已经有自动化的工具在检查了。

如果还有其他风格或一致性需求，我会直接提出要求，或者我会在上面添加提交，包含必要的更改。

检查代码

  • 检查并阅读代码，看看它是否合理，在本地运行它，看看它是否真的解决了问题。

  • 然后评论说你已经做了，这样我才知道你真的检查了它。

信息

不幸的是，我不能简单地信任只有几个批准的 PR。

很多次，PR 有 3、5 个或更多个批准，可能是因为描述很吸引人，但当我检查 PR 时，它们实际上是错误的，有 bug，或者没有解决它们声称要解决的问题。😅

所以，你真正阅读和运行代码，并在评论中告诉我你做了，这一点非常重要。🤓

  • 如果 PR 可以简化，你可以要求这样做，但没有必要过于挑剔，可能会有很多主观的观点（我也会有自己的观点🙈），所以如果你能专注于基本的东西会更好。

测试

  • 帮我检查 PR 是否有测试。

  • 检查 PR 之前测试是否失败。🚨

  • 然后检查 PR 之后测试是否通过。✅

  • 许多 PR 没有测试，你可以提醒他们添加测试，或者你甚至可以自己建议一些测试。这是最耗时的事情之一，你可以在这方面提供很大帮助。

  • 然后也评论你尝试了什么，这样我就知道你检查了它。🤓

创建拉取请求

你可以贡献到源代码中，例如

  • 修复你在文档中发现的错别字。
  • 提出新的文档部分。
  • 修复现有的问题/bug。
    • 确保添加测试。
  • 添加新功能。
    • 确保添加测试。
    • 如果相关，请确保添加文档。

帮助维护 Typer

帮我维护Typer！🤓

有很多工作要做，其中大部分工作你都可以做。

你现在可以做的主要任务是

这两个任务是最耗时的。这是维护 Typer 的主要工作。

如果你能在这方面帮助我，你就是在帮助我维护 Typer，并确保它更快更好地发展。🚀

加入聊天

加入👥 FastAPI 和朋友 Discord 聊天服务器 👥 并与社区中的其他人一起闲逛。有一个#typer频道。

提示

对于问题，请在 GitHub Discussions 中提出，在那里你更有可能获得帮助。

仅将聊天用于其他一般性对话。

不要将聊天用于问题

请记住，由于聊天允许更多“自由对话”，因此很容易提出过于笼统且难以回答的问题，因此你可能无法得到答案。

在 GitHub 上，模板将引导你写出正确的问题，以便你可以更容易地获得好的答案，甚至在提问之前就解决问题。在 GitHub 上，我可以确保我始终回答所有问题，即使需要一些时间。我无法在聊天中亲自做到这一点。😅

聊天中的对话也不像 GitHub 中那样容易搜索，因此问题和答案可能会在对话中丢失。

另一方面，聊天中有数千名用户，因此你很有可能找到人与之交谈，几乎一直如此。😄

你也可以通过 GitHub 赞助 在经济上支持作者（我）。

在那里你可以给我买一杯咖啡☕️以表示感谢。😄

正如你在文档中所见，Typer 是建立在 Click 之上的。

你也可以赞助

谢谢！🚀