Помоги FreeCAD

From FreeCAD Documentation
Revision as of 07:21, 23 May 2019 by Mad max (talk | contribs) (Created page with "Подробнее о переводе см. Localisation#Translating the wiki.")
Jump to navigation Jump to search
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎български • ‎русский • ‎українська • ‎中文(中国大陆)‎ • ‎中文(台灣)‎ • ‎日本語 • ‎한국어

Если вам нравится FreeCAD и вы хотите помочь в его разработке, вы можете сделать много вещей, даже если вы не программист.

Работа над документацией

Помогите нам составлять, корректировать и расширять документацию. Исправляйте ошибки, расширяйте или исправляйте непонятные страницы, создавайте новые страницы, если тема упущена, и так далее. Внести свой вклад в развитие FreeCAD wiki просто, на WikiPages вы можете найти общие рекомендации и помощь, необходимую для начала работы. Для редактирования вики вам понадобится вики-аккаунт с правами «Редактора» (вики защищена от записи во избежание спама). Вы можете запросить учетную запись на форуме или на канале irc. Но учтите, что канал IRC может быть не так отзывчив, как форум.

Несколько областей, которые ждут вашей помощи:

  • На странице Category:Command Reference перечислены и документированы все комманды FreeCAD. Большинство из них содержат мало или вообще никакой информации. Пожалуйста, обратитесь к WikiPages для ознакомления с примерами того, как должны выглядеть страницы документации команд.
  • Секции Учебники нужны примеры того, как использовать верстаки. Если вы разработали что-то классное в FreeCAD, почему бы не задокументировать, как вы это сделали для потомков?
  • Здесь можно посмотреть открытые тикеты в багтрекере любезно отмеченные тегом "documentation".

Поделитесь своими знаниями FreeCAD

Сообщество пользователей вокруг FreeCAD все еще невелико, но уже включает в себя несколько опытных пользователей, которые выполняют очень важную работу, показывая новичкам, как использовать программное обеспечение. Если вы начинаете чувствовать себя комфортно работая с FreeCAD, ваши знания могут быть очень ценными для других, и вы можете внести свой посильный вклад делая следующее:

  • Покажите работы которые вы выполнили в FreeCAD на Users Showcase forum. Вы можете опубликовать скриншоты и, что еще лучше, прикрепить файлы FreeCAD, чтобы другие люди могли их изучить и понять, как вы это сделали.
  • Запишите видео показывающее, как вы сделали что-то интересное во FreeCAD. Такое видео обычно отлично демонстрирует новые функции.
  • Напишите примеры описывающие или обучающие чему-то интересному. Вы можете написать свои примеры в своем блоге, прямо в нашей вики или даже на форуме.
  • Опубликуйте в Mastodon социальной сети с открытым исходным кодом (и follow FreeCAD здесь) или в нашей группе в социальной сети Facebook.

Переведите FreeCAD

Переведите FreeCAD на свой язык. Все текстовые строки интерфейса FreeCAD могут быть легко переведены на другие языки. Все, что нам нужно, это кто-то, кто знает другой язык и готов помочь! Все переводы доступны онлайн на Crowdin.

Подробнее о переводе см. Локализация.

Переведите документацию

Переводить легко, вики FreeCAD поддерживает плагин для перевода, который позволяет переводить базовую английскую страницу на другие языки.

Подробнее о переводе см. Localisation#Translating the wiki.

Please be sure you are familiar with the basics of wiki markup; see Help:Editing for a reference.

Then head to WikiPages to familiarize yourself with the style used in this wiki, particularly when it comes to templates.

Help others to know FreeCAD

  • 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

Report bugs and ask for interesting features

Bugreport-workflow.png

Although the place to report confirmed bugs and suggest new features is eventually the FreeCAD Tracker, 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, and do this from the Part or PartDesign workbench.
  • 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 cancelled 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 unrealistic amount of work.

Design artwork

See the Artwork page for guidelines about designing icons for 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. To avoid headaches 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 also participates in the Google Summer of Code. Be sure to check our ideas there if you are interested in participating in a next edition.