Jump to content

帮助FreeCAD

From FreeCAD Documentation
This page is a translated version of the page Help FreeCAD and the translation is 90% complete.

简介

如果你喜欢FreeCAD,也愿意为FreeCAD提供帮助,即使你不是一名程序员,除了捐赠和投入时间以外,你仍有很多事情可做。

捐赠

尽管FreeCAD的开发不依赖捐赠,但是您的捐赠可以帮助FreeCAD进一步的发展壮大。捐赠页面列出了您可以向FreeCAD进行捐赠的所有选项。

文档工作

帮助我们构建、修正并扩充这份文档。例如修正错误,扩充并修正表达不清晰的页面,创建主题缺失的页面。为FreeCAD wiki的文档做贡献很简单,在WikiPages页面,你能找到起步所需的指导以及帮助。要编辑wiki,你需要一个具有编辑权限的wiki账号(为避免网络垃圾,wiki是写保护的)。你可以通过论坛或者IRC频道索要一个账号。注意IRC频道的响应应该没有论坛快。FreeCAD官网论坛是主要的提问和讨论地方,它将保存社区的经验与知识。

一些期待您工作的地方:

  • 范畴:命令参考页面列出了所有FreeCAD命令文档。它们大多数还只含有很少的信息,或者根本就是空白的。良好的命令文档页面如何编写您可以参考WikiPages。
  • 教程部分需要一些例子以说明如何使用工作台。如果你用FreeCAD做出了挺酷的东西,为什么不为后人记录下来你的做法呢?
  • 在FreeCAD的Bug追踪中仍有一些具有"文档"标签的,期待您的关照。

分享你的FreeCAD知识

虽然FreeCAD的使用者社群还比较小,但是那里已经有好几位高级用户,他们向新人展示如何使用这个软件,这可是很重要的活儿。如果你开始感觉熟悉了FreeCAD,用着挺舒服,那么你的知识对别人就可能非常有价值。比如说,你可以在以下几个方面作出贡献:

  • 在用户展示论坛秀出你的作品。你可以贴出截屏,最好能附上你的FreeCAD文件,这样别人就能检验它,来理解你是怎么做的。
  • 录制视频,演示你怎样使用FreeCAD,怎样做出了有趣的东西。这些视频通常在展示新功能方面功不可没。
  • 撰写教程,描述或教授你觉得有意思的东西。你可以在你自己的博客里写教程,然后把它指向我们的wiki,或者直接写在论坛里。
  • 在Mastodon开源社交网络发帖(点这里关注FreeCAD),在Facebook或是Twitter上讨论(点这里在Twitter上关注FreeCAD)。使用标签#FreeCAD或#MadeWithFreeCAD或#fc3d来便于其他FreeCAD使用者更方便找到这些帖子。
  • 请浏览Reddit、3dprinting.stackexchange、StackOverflow等网站上关于FreeCAD的最新帖子。试着回答这些问题,并参与讨论,分享您的经验和信息。
  • 请登录FreeCAD的IRC频道或访问其他讨论组。

翻译FreeCAD

把FreeCAD翻译为你的母语。FreeCAD界面上所有的文字都可以方便地翻译为其他语言。我们需要懂那门语言并愿意提供帮助的人。所有的翻译工作都通过Crowdin在线完成。

关于翻译的详情,请参考本地化。

翻译文档

翻译很简单,FreeCAD wiki提供了一个翻译插件允许你将基本的英文页面翻译为其他语言。

关于翻译的详情,请参考本地化 翻译维基。

请确认你熟悉基本的wiki标记语法;参考帮助:编辑。

到WikiPages熟悉本wiki的样式风格,特别是一些模板文件。

帮助别人了解FreeCAD

  • 同可能感兴趣的人谈论FreeCAD。
  • 为FreeCAD找到有趣的用法并记录下来,例如用截屏的方式。FreeCAD还很年轻,并没有很多人知道能用它做什么。如果你已经是FreeCAD的粉丝,你肯定知道如何用FreeCAD来做一些很酷的事情。那就帮我们秀给其他人吧!
  • 挂在论坛上,帮助新来的人去解答一些基础的问题。
  • 撰写教程、录个视频等。展示你用FreeCAD做什么。
  • 贡献源文件、图纸等。我们仍缺少好的示例文件去展示FreeCAD能用来做什么。
  • 通过在Github上给FreeCAD 仓库“打星”和“关注”来推广FreeCAD。

报告错误和要求新增有趣的功能

虽然报告错误和建议新功能的最终渠道还是GitHub 上的FreeCAD问题追踪器,但请首先将错误报告和功能请求发布到论坛上。为了节省开发人员的时间(因为对难以理解的错误进行分类和处理可能非常耗时),以及避免因为您的问题未按照您期望的方式处理而产生不满情绪,请阅读以下内容:

  • 错误和功能需求都通过同一个跟踪系统进行处理。只需将您的问题标记为“错误”(不按照预期正常运行)或“功能”(尚未存在但您认为应该添加的功能)即可
  • 虽然最初您可以匿名提交问题,但不幸的是,由于垃圾邮件的原因,这一功能不得不取消。现在,如果您想要创建或编辑工单,就必须先创建一个账户。之后,当有人为该问题添加备注时,默认会通知您。在很多情况下,处理该问题的人将需要您提供更多的信息。
  • 在报告错误时,最关键的一点是要让开发人员能够重现该错误。请务必详细列出导致错误出现的具体步骤,以便其他人也能按照这些步骤操作,从而在自己的设备上也看到该错误的发生。如果开发人员无法看到该错误,那么他也无法解决该问题。
  • 同时,请提供有助于开发人员定位问题的相关信息,例如您运行 FreeCAD的操作系统、FreeCAD的确切版本以及相关的库。请在菜单中的“帮助”→“关于 FreeCAD”对话框中通过点击“复制到剪贴板”按钮粘贴所有数据。
  • 无论您多么确信自己已经发现了漏洞,请务必先在 帮助论坛中讨论这个问题。
  • 在提交功能请求之前,请先在 开放讨论论坛 上与其他用户进行讨论,这样您可能会提出一个更完善的方案,从而有更大的机会吸引开发人员来实现它。
  • 请记住,FreeCAD是由志愿者们利用业余时间开发的。尽管每个人都尽力打造出最出色的软件,但您的错误报告可能会被置于较低的处理优先级,或者因为您未能提供足够的信息而被取消处理。您的功能请求也可能被推迟,甚至被拒绝,因为可能没有开发人员有兴趣实现该功能,或者该请求会涉及不切实际的工作量。

错误分类

每周在GitHub上都会报告出数十个问题。阅读这些报告、对其分类、确认问题是否能复现、是否可以采取一些简单的措施、要求提问人提供更多信息,都要花费大量时间。协助分类工作很简单,只需访问GitHub,然后在您认为自己能够提供帮助的任何问题上发表评论即可!

设计图形作品

查看Artwork和Artwork Guidelines页面获取为FreeCAD设计图标的相关指导。

编程

给FreeCAD写代码并不难,并且你不需要任何批准。你可以马上开始,做一些你想做的工作,然后在跟踪器上提交一个补丁,或者在git分支上请求一次融合。不过,为了少一点头疼事,你还是应该先看看下面的前提条件:

  • FreeCAD有它自己的节奏,它只有很小的一个开发者队伍。我们想投入足够的时间,但是时间总是不够。我们也没有事先计划,总是哪位开发者看着合适又有时间,事情就这样办好了。所以,我们不做什么待办任务列表。你自己决定你喜欢做什么,比如说一个错误你想修正,或者一个缺失的功能你来实现。跟踪器里也有一些议题,还没有分派给任何人。
  • 在你开始为FreeCAD写代码之前,你必须熟悉FreeCAD怎样工作。这看起来是显然的。你如果你不知道它的预期行为,你心里其实也就不知道做什么和怎么做。
  • 几乎所有的事情都可以通过Python或C++实现。在两种语言中,内核的表现几乎一致。即使你打算用C++编程,我们还是建议你通读发烧友中心页面,因为它会给你关于内核的一个整体认知。
  • 如果你用C++编程,请先确保你能不带错误地编译。
  • 把你自己介绍给其他开发者。FreeCAD不是别的,它首先是一个社交项目。在实现任何东西以前,我们在论坛里已经有很多讨论了。所以我们给你一个好建议,每次在真正着手之前,先和大家讨论一下你的想法,告诉他们你计划做什么。我们也有一个异步通讯频道,然而论坛才是唯一那个你能遇到所有开发者的地方。
  • 从2016年开始,FreeCAD也参与 谷歌编程夏令营项目。如果你有兴趣参加下一季活动,请先看看我们的点子。

Writing code for FreeCAD is not hard, and you don't need any permission, you can start right now to work on something you want, then submit a patch on the issue tracker or request a merge from a git branch. To avoid headaches you should meet the following prerequisites first:

  • Information how to compile FreeCAD is available for different operating systems.
  • Before you start to code for FreeCAD, you must know how FreeCAD works. This seems obvious, but if you don't know how it is supposed to work you won't know what to do internally or how to do it.
  • Almost everything can be done either in Python or C++. The internals work almost the same in both languages. We suggest you read through the Power users hub pages, even if you're going to code in C++ since it will give you a good overview of the internals.
  • If you are going to work in C++, make sure you can compile FreeCAD without problems first.
  • Present yourself to other developers. FreeCAD is before anything a social project, we discuss a lot of things on the forum before implementing it, and it's always best to discuss your ideas and tell people what you are planning to do before actually doing it. We also have an IRC channel which is synchronized with our Matrix channel, as well as a Discord channel.
  • Since 2016, FreeCAD also participates in the Google Summer of Code 2020. Be sure to check our ideas there if you are interested in participating in the next edition.
  • More and more of the FreeCAD functionality is not written in the FreeCAD code itself but in addons, macros and extensions. Together, this ecosystem is what makes FreeCAD powerful. Oftentimes, working on an addon is easier because there is less code to read and understand, and fewer people involved. check the Addons repository and Macros repository to get some ideas!

Create models

FreeCAD features a Models library that is free and open to everyone. Why not add some useful parts there, that could be reused by others? Be sure to create models yourself from scratch, to keep the library 100% free of possibly copyrighted or non-free components.