Помоги FreeCAD

From FreeCAD Documentation
Revision as of 17:46, 1 March 2020 by Asv (talk | contribs) (Created page with "* Поговорите о FreeCAD с другими людьми, которые могут быть заинтересованы * Найдите интересное исп...")

Introduction

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

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

Помогите нам составлять, корректировать и расширять документацию. Исправляйте ошибки, расширяйте или исправляйте непонятные страницы, создавайте новые страницы, если тема упущена, и так далее. Внести свой вклад в развитие вики FreeCAD просто, на страницах вики вы найдёте общие рекомендации и справку, необходимую для начала работы. Для редактирования вики вам понадобится вики-аккаунт с правами «Редактора» (вики защищена от записи во избежание спама). Вы можете запросить учетную запись на форуме или на канале 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.

Пожалуйста, убедитесь, что вы знакомы с основами вики-разметки; для справки смотрите Помощь:Редактирование.

Затем перейдите на WikiPages чтобы ознакомиться со стилем, используемым в этой вики, особенно когда речь идет о шаблонах.

Помогите другим узнать о FreeCAD

  • Поговорите о FreeCAD с другими людьми, которые могут быть заинтересованы
  • Найдите интересное использование FreeCAD и задокументируйте его, например, со снимками экрана. FreeCAD очень молод, и не многие люди видят, что они могут с ним сделать. Если вы уже являетесь поклонником FreeCAD, вы наверняка знаете, что может сделать FreeCAD. Помогите нам показать это другим!
  • Посещайте форум, помогайте новичкам решать основные вопросы
  • Пишите пособия, записывайте видео и т.д., показывающее, что вы делаете с FreeCAD
  • Помогайте с файлами, чертежами и т.д. Нам все еще не хватает хороших примеров о том, что можно сделать с помощью FreeCAD
  • Помогите продвинуть FreeCAD на GitHub "Starring" and "Watching" Репозиторий FreeCAD

Сообщайте об ошибках и запрашивайте интересные функции

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

  • Ошибки и запросы новых функций обрабатываются на одном трекере. Просто пометьте свою проблему как «bug (ошибка)» (что-то, что не работает должным образом) или «feature (функция)» (что-то, чего нет, но вы думаете, что было бы хорошо иметь)
  • Изначально все могли сообщать о проблемах анонимно, к сожалению, это пришлось отменить из-за спама. Теперь, если вы хотите создать/отредактировать заявку, вам нужно будет создать учетную запись. Тогда вы по умолчанию будете уведомлены, когда кто-то добавит примечание к проблеме. Во многих случаях человеку, который будет обрабатывать ошибку, потребуется дополнительная информация от вас.
  • При сообщении об ошибке наиболее важным моментом является возможность разработчиком воспроизвести ее. Обязательно укажите точные шаги, необходимые для воспроизведения ошибки, чтобы другой человек мог сделать то же самое и увидеть, что ошибка произошла и на его компьютере. Если разработчик не видит ошибку, он не может ее устранить.
  • Также включите информацию, которая может помочь разработчикам определить причину проблемы, такую ​​как операционная система, на которой вы работаете с FreeCAD, точная версия FreeCAD и соответствующие библиотеки. Опубликуйте все данные, используя кнопку «копировать в буфер обмена» в меню «Справка» (меню) → диалог "о FreeCAD", сделайте это из верстака Part или PartDesign.
  • Независимо от того, насколько вы уверены, что нашли ошибку, всегда сначала обсуждайте их на Справочном форуме.
  • Перед отправкой запроса на функцию всегда сначала обсудите её с другими пользователями на Открытом дискуссионном форуме, так как вы можете получить более солидное предложение с большим количеством шансов заинтересовать разработчика реализовать его.
  • Помните, что FreeCAD разрабатывается добровольцами, которые используют свое свободное время для работы над ним. Хотя каждый старается изо всех сил создать лучшее из возможных приложений, ваш отчет об ошибке может быть обработан с низким приоритетом или отменен, если вы не можете предоставить достаточно информации, а ваш запрос функции может быть отложен или даже отклонен, если ни один разработчик не заинтересован в её реализации или если это потребует нереального объема работы.

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 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.

Графический Дизайн

На странице Artwork приведены рекомендации по разработке иконок для FreeCAD.

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

Программируй!

Написание кода для FreeCAD не сложно, и вам не нужно никакого разрешения, вы можете начать прямо сейчас работать над чем-то, что вам нужно, а затем отправить патч на tracker или запросить слияние из git-ветки [1]. Чтобы избежать головной боли, для начала вы должны выполнить следующие условия:

  • FreeCAD движется в своем собственном темпе и имеет очень небольшую команду разработчиков. У нас не так много времени, как мы хотели бы посвятить FreeCAD, и дела не запланированы заранее; они делаются, когда какой-то разработчик считает это подходящим и когда он находит время, чтобы сделать это. Поэтому мы не поддерживаем список задач, которые необходимо выполнить. Вам нужно найти что-то, что вы хотели бы сделать, например, дефект, который вы хотели бы исправить, или небольшую функцию, которая, по вашему мнению, отсутствует. Также tracker содержит некоторые элементы, которые еще никому не назначены.
  • Прежде чем начать писать код для FreeCAD, вы должны хорошо знать, как работает FreeCAD. Это кажется очевидным, но если вы не знаете, как это должно работать, вы не будете знать, что делать внутри или как это сделать.
  • Почти все можно сделать либо на Python, либо на C ++. Внутри все работает почти одинаково на обоих языках. Мы предлагаем вам прочитать страницы Центр опытных пользователей, даже если вы собираетесь писать код на C ++, так как он даст вам хороший обзор внутренних компонентов.
  • Если вы собираетесь работать в C ++, сначала убедитесь, что вы можете без проблем скомпилировать FreeCAD.
  • Представьтесь другим разработчикам. FreeCAD - это прежде всего социальный проект, мы много обсуждаем на форуме перед реализацией чего-либо, и всегда лучше обсудить ваши идеи и рассказать людям, что вы планируете делать, до того как сделаете это. У нас также есть [irc: //chat.freenode.net/freecad IRC канал], но форум - это единственное место, где вы можете встретиться со всеми разработчиками.
  • С 2016 года FreeCAD также участвует в Google Summer of Code. Не забудьте проверить наши идеи там, если вы заинтересованы в участии в следующем выпуске.

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 the next edition.