Help FreeCAD/zh-cn

简介

如果你喜欢FreeCAD,也愿意为它的开发工作提供帮助,即使你不是一名程序员,除了捐献以外,你仍有很多事情可做。

Although FreeCAD doesn't need money to be developed, donations can help the project to grow further and faster. The Donate page lists all the options you have to donate money to the project.

文档工作

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

一些期待您工作的地方:

分享你的FreeCAD知识

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

翻译FreeCAD

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

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

翻译文档

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

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

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

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

帮助别人了解FreeCAD

  • 和可能有兴趣的人谈论FreeCAD。
  • 为FreeCAD找到有趣的应用场景,并记录下来,比如用截屏的方式。FreeCAD还很年轻,还没有很多人知道能用它做什么。如果你已经是FreeCAD的粉丝,你肯定知道如何用FreeCAD做一些很酷的事情,那就帮我们秀给其他人吧!
  • 挂在论坛上,帮助新来的人,解答他们基础性的提问。
  • 撰写教程,录制视频,等等。演示出你用FreeCAD做什么。
  • 贡献源文件,图纸,等等。我们还缺好的示例文件,展示FreeCAD能用来做什么。
  • 帮助在Github上推荐FreeCAD,给FreeCAD 仓库'Starring'打星和'Watching'关注
  • Talk about FreeCAD to other people who might be interested
  • Find interesting uses for FreeCAD, and document it, for example with screenshots. FreeCAD is very young, and not many people see what they can do with it. If you are a FreeCAD fan already, you surely know some cool thing FreeCAD can do. Help us to show that to others!
  • Hang on the forum, and help newcomers to solve basic questions
  • Write tutorials, record videos, etc., showing what you do with FreeCAD
  • Contribute with files, drawings, etc. We still lack good example files of what can be done with FreeCAD
  • Help to promote FreeCAD on GitHub by "Starring" and "Watching" the FreeCAD repository

报告有错误和请求加功能

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

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

Although the place to report confirmed bugs and suggest new features is eventually the FreeCAD Issue Tracker on GitHub, please always post bug reports and feature requests to the Help forum first. In order to save developers time (triaging and handling hard to understand bugs can be very time consuming), and avoid frustrations because your issue was not handled the way you would like, please read the following:

  • Bugs and features requests are handled in the same tracker. Just mark your issue as "bug" (something that doesn't work as it should) or "feature" (something that is not there but you think it would be good to have)
  • Although originally you could submit issues anonymously, unfortunately this had to be cancelled due to spam. Now if you would like to create/edit tickets you will have to create an account. You will then by default be notified when someone adds notes to the issue. In many cases, the person who will handle the bug will need more information from you.
  • When reporting a bug, the most important point is to allow developers to reproduce it. Be sure to include the exact steps needed to make the bug happen, so another person can do the same and see the bug happen on his machine too. If the developer cannot see the bug, he cannot solve it either.
  • Also include information that can help developers to situate the problem, like the operating system you are running FreeCAD on, the exact version of FreeCAD and the relevant libraries. Please post all the data by using the "copy to clip board" button in the Help (menu) → about FreeCAD dialogue.
  • No matter how sure you are that you have found a bug, please always discuss bugs first in the Help forum.
  • Before submitting a feature request, always discuss it with other users first on the Open discussion forum, so you might end up with a more solid proposal, with more chances to interest a developer to implement it.
  • Remember that FreeCAD is developed by volunteers who use their free time to work on it. Although everyone tries his best to make the best possible application, your bug report might be treated with low priority, or canceled if you cannot give sufficient information, and your feature request might be postponed or even refused if no developer has interest in implement it or if that would request an unrealistic amount of work.

Triage bugs

There are dozens of bugs reported on GitHub weekly. It takes a lot of time to read them, categorize them, verify if the issue is reproducible, see if some easy actions can be done, or ask the person who posted the issue to provide more information. Helping to triage is easy, just head over the GitHub and start commenting on any issue where you think you might be able to help!

设计艺术品

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

See the Artwork and Artwork Guidelines page for guidelines about designing icons for FreeCAD.

编程!

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

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.