帮助FreeCAD

From FreeCAD Documentation
Revision as of 03:36, 28 August 2018 by Johnquicker (talk | contribs) (填补空白)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

如果你喜欢FreeCAD,也想帮助它的开发,即使你不是程序员,你也能做很多事情。实际上,不管你是普通使用者,高级发烧友,还是软件开发者,这里都有你可以做的事情。

文档工作

帮助我们撰写、更正和丰满这个文档。比如说,改正错误;遇到不清楚的页面,帮我们扩展内容或修改表达方式;给缺失的主题创建新页面,等等。为FreeCAD的文档做贡献很简单,在WikiPages页面,你能找到FreeCADwiki的约束条件,还有帮你起步的内容。要编辑wiki,你可以在论坛索要一个账号, 或者通过irc 频道。不过IRC频道里的反应不一定像论坛里那么快。

这些领域欢迎你来工作:

  • 范畴:命令参考页面列出了关于FreeCAD所有命令的相关文档。他们大多数只含有很少的信息,或者根本还是空白。请您参考WikiPages,那里有一些例子,说明什么样子是比较好的命令文档页面。
  • 教程部分也很不够。如果你用FreeCAD做出了挺酷的东西,为什么不为后人记录下来你的做法呢?
  • 在FreeCAD的抓虫者系统, 有一些开口机票,打有“文档”标签,它们在等待有爱的你。(Open tickets,原意是可以不确定时间和地点的返程机票,这里指遗留下来有待填补的工作。-译者注)

分享你FreeCAD的知识

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

  • 用户展示论坛秀出你的作品。你可以贴出截屏,最好能附上你的FreeCAD文件,这样别人就能检验它,来理解你是怎么做的。
  • 录制视频,演示你怎样使用FreeCAD,怎样做出了有趣的东西。这些视频通常在展示新功能方面功不可没。
  • 撰写教程,描述或教授你觉得有意思的东西。你可以在你自己的博客里写教程,然后把它指向我们的wiki,或者直接写在论坛里。
  • 在我们的FreeCAD Google PlusFacebook社区发帖。

翻译FreeCAD

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

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

翻译文档

翻译过程简单方便,FreeCADwiki有一个翻译插件,支持各页面之间的翻译和链接。

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

确保你熟悉了WikiPages中的风格指导,那里有关于什么是好的翻译的一些规定。

帮助编辑页面提供了关于编辑的一些信息。

帮助别人了解FreeCAD

  • 和可能有兴趣的人谈论FreeCAD。
  • 为FreeCAD找到有趣的应用场景,并记录下来,比如用截屏的方式。FreeCAD还很年轻,还没有很多人知道能用它做什么。如果你已经是FreeCAD的粉丝,你肯定知道如何用FreeCAD做一些很酷的事情,那就帮我们秀给其他人吧!
  • 挂在论坛上,帮助新来的人,解答他们基础性的提问。
  • 撰写教程,录制视频,等等。演示出你用FreeCAD做什么。
  • 贡献源文件,图纸,等等。我们还缺好的示例文件,展示FreeCAD能用来做什么。
  • 帮助在Github上推荐FreeCAD,给FreeCAD 仓库'Starring'打星和'Watching'关注

报告有错误和请求加功能

Simplified Chinese version of Bugreport-workflow.png
Simplified Chinese version of Bugreport-workflow.png

你要提交确认错误和建议新的功能,虽然最终要通过FreeCAD跟踪器完成,但是请你每次都先在论坛的帮助板块发帖出来。这里有一些经验之谈,一方面是为了节省开发者的时间(辨别先后和找到焦点,都建立在理解错误的基础上,这很费时间),另一方面也是为了避免造成你的沮丧(你的议案没有得到你所期望的处理),请阅读以下内容:

  • 报告出错和索要功能都通过同一个跟踪器处理。所以,请给你的议案打上标签,要么是"bug"(那些没有按照本该有的样子工作的东西),要么是"feature"(那些你想它有而却没有的东西)。
  • 虽然原来你可以匿名提交议案,但是很不幸,拜推广程序所赐,我们不得不封锁了匿名提交。现在,如果你想创建或编辑议案项目,你就得创建一个账号。这样你也将得到一些便利,比如有人向你的议案添加了记录时,你会收到通知。在很多情况下,那个将要处理你提交的出错议案的人,也会需要从你的这里取得更多信息。
  • 报告错误时,最重要的一点就是让开发者能够让这个错误重新出现。你要提供准确的步骤,让这个错误出现,这样另一个人照着做,就能在他的机器上看到这个错误。如果开发者连错误都看不到,那么他也无法解决这个问题。
  • 你发现了一个错误,无论你多么确定这一点,请每次都先在帮助论坛发帖,大家讨论一下这个错误。
  • 在提交新功能要求之前,务必先在开放论题板块跟大家讨论一下,这样你会打磨出更好的提案,它言之有物,才能有更大的可能性引起开发者的兴趣来实现它。
  • 别忘了FreeCAD是由志愿者们开发的,他们利用的都是业余时间。虽然每个人都尽他所能地作出最好的应用,但是咱们还是要把丑话说在前头。如果你提交错误报告时不能提交足够的信息,你的报告可能会被调低优先级或者干脆被取消。如果你提出的功能要求不能引起开发者的兴趣,或者它需要超乎想象的工作量,那么它可能会被延后处理,甚至被拒绝。

设计艺术品

看看 艺术品页面,那里有给FreeCAD设计图标的指南。

Program!

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 tracker or request a merge from a git branch. But to avoid some headache you should meet the following prerequisites first:

  • FreeCAD goes at its own pace, and has a very small team of developers. We have not as much time as we would like to dedicate to FreeCAD, and things are not planned ahead, they are done when some developer sees it fit and when he finds time to do it. So we don't maintain a list of tasks to be done. It is up to you to find something you would like to do, for example a defect you would like to correct, or a small feature you think is missing. The tracker also contains some items that are not yet assigned to anybody.
  • Before you start to code for FreeCAD, you must know well 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, but the forum is the one and only place where you can meet all the developers.
  • Since 2016, FreeCAD is also participating to the Google Summer of Code. Be sure to check our ideas there if you are interested in participating in a next edition.