This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
community:contribute [2019/05/28 20:30] – fixed forum links and few typos lordofbikes | community:contribute [2020/01/24 19:37] (current) – Remove under work notice flywire | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ** This section is under work** | + | ====== |
- | + | ||
- | ====== | + | |
The basic nature of LibreCAD as an open source free software is to **be open to improvement**. The variety of contributor profiles makes LibreCAD richer so //everybody is welcomed !// Beginners have a fresh look and may report issues that experienced users are used to and do not report. | The basic nature of LibreCAD as an open source free software is to **be open to improvement**. The variety of contributor profiles makes LibreCAD richer so //everybody is welcomed !// Beginners have a fresh look and may report issues that experienced users are used to and do not report. | ||
Contributing includes various aspects and skills: | Contributing includes various aspects and skills: | ||
- | * **coding:** fixings bugs, implement new features, extend current features, maintenance. | + | * **support**: answer to questions from users on [[http:// |
- | * **testing** new features for bugs or improvements. | + | |
- | * **translating** the user interface or the documentation from English to your language. (lien page translation). | + | |
* **documentation: | * **documentation: | ||
* [[https:// | * [[https:// | ||
* this DokuWiki : share useful information such as tutorials, FAQ, best practices. | * this DokuWiki : share useful information such as tutorials, FAQ, best practices. | ||
- | * support | + | * **translating:** the user interface or the documentation |
+ | * **coding:** fixings bugs, implement new features, extend current features, maintenance. | ||
+ | * **testing: | ||
As you can see, **even beginners can contribute** through feed-backs, testing or documentation. Contributing is also an opportunity to develop your skills. | As you can see, **even beginners can contribute** through feed-backs, testing or documentation. Contributing is also an opportunity to develop your skills. | ||
Line 18: | Line 16: | ||
The team set up tools (Github, forums, Wiki) and communication channels to ask for help and to coordinate. The most convenient channel to connect with contributors are the [[http:// | The team set up tools (Github, forums, Wiki) and communication channels to ask for help and to coordinate. The most convenient channel to connect with contributors are the [[http:// | ||
- | Please see the following sections for coding, translating LibreCAD in your language and documentation. | + | Please see the following sections for [[community:contribute_code|coding]], [[community:contribute_translate|translating LibreCAD]] in your language and [[community:contribute_documentation|documentation]]. |
- | + | ||
- | ===== Write code ====== | + | |
- | + | ||
- | LibreCAD code is hosted by [[https:// | + | |
- | + | ||
- | + | ||
- | ===== Need for developers ===== | + | |
- | + | ||
- | LibreCAD is coded with: | + | |
- | * C++ | + | |
- | * Qt | + | |
- | + | ||
- | + | ||
- | ===== Translating LibreCAD in your language ===== | + | |
- | + | ||
- | ==== Context ==== | + | |
- | + | ||
- | English is used for developing LibreCAD code, for the GUI and for all the documentation. | + | |
- | GUI translators ensure that the LibreCAD interface is available in //other languages// | + | |
- | + | ||
- | The list of languages available is given at [[http:// | + | |
- | + | ||
- | ==== How to translate? ==== | + | |
- | + | ||
- | For translating | + | |
- | + | ||
- | === If you are a new translator === | + | |
- | You need to set up your account: | + | |
- | - Create an account on LibreCAD | + | |
- | - Go to the [[http:// | + | |
- | - Go to the LibreCAD-translate Sub-Forum and post your request for permissions with your //Pootle username// and the // | + | |
- | - When the administrator sets the permissions for your Pootle account, you will get a reply in the forum and can then start using the Translation Server. | + | |
- | + | ||
- | === Pootle setup === | + | |
- | + | ||
- | For worldwide collaboration on translating LibreCAD GUI in many languages, a Web application for translation is necessary. LibreCAD uses Pootle for this job. The //ts// files are imported into Pootle database and during a synchronization //ts// files are updated from the database. | + | |
- | + | ||
- | After activating | + | |
- | + | ||
- | To join a language select it in the // | + | |
- | + | ||
- | Then you will have the links to your language and LibreCAD project in your // | + | |
- | + | ||
- | === Translating === | + | |
- | + | ||
- | Use the LibreCAD project link on your // | + | |
- | + | ||
- | Until the translation is complete, you see links in the //Overview Summary// column with the number of words needing attention. Click on that link and you get directed to the first word or string that needs attention. Needing attention means, that there is no translation at all or there is a translation, | + | |
- | + | ||
- | == Searching == | + | |
- | If you found an issue in the application, | + | |
- | + | ||
- | == Suggestions == | + | |
- | + | ||
- | Translations may have one or multiple suggestions. These suggestions are made by members who are not allowed to submit translations or by unregistered users. To work on suggestions, | + | |
- | + | ||
- | When you accept a suggestion, it is transferred to the editor and you can edit it or submit it unchanged. Delete other suggestions if present, before submitting, or you will be directed to this translation again later. | + | |
- | + | ||
- | == Fuzzy == | + | |
- | + | ||
- | If you are not sure about a translation, | + | |
- | + | ||
- | == Submit == | + | |
- | + | ||
- | After editing a translation click the //Submit// button to save your changes. Be sure about the state of the //Fuzzy// check box : the translation will find its way to the application only when it is unchecked. | + | |
- | + | ||
- | == Synchronization == | + | |
- | + | ||
- | Since the translation server is not GitHub, we have to sync both servers. From time to time, the Translation server pulls latest changes from GitHub to update the local Git repository. The changes from Pootle server are merged to the local Git repository. Then the local Git repository is pushed back to GitHub. So changes on the Translation server can only be found on GitHub after this sync process. Only the version on GitHub is recognized for deployment. If you have reached a milestone in your translation progress and wish to have a sync, please post your request in the LibreCAD-translate forum. | + | |
- | + | ||
- | == Standard dialogs == | + | |
- | + | ||
- | There are standard dialogs in LibreCAD, e.g. file open or save, which may be not translated in other languages. These dialogs use a translation dictionary file deployed with Qt, because the source for these dialogs is in the Qt source code files. LibreCAD deploys the Qt //qm// files, but LibreCAD supports much more languages than Qt. So if Qt does not support your language then these standard dialogs are not translated when LibreCAD is used with this language. | + | |
- | + | ||
- | If there are any issues, feel free to post in the LibreCAD-translate Sub-Forum. | + | |
- | + | ||
- | + | ||
- | ===== Contribute to the documentation ===== | + | |
- | + | ||
- | The documentation is very important to users. It helps to understand how LibreCAD interacts with the user and guide him with some good practices linked to LibreCAD. | + | |
- | + | ||
- | The community | + | |
- | * **editors** | + | |
- | * **architects** | + | |
- | + | ||
- | ==== Need for editors ==== | + | |
- | + | ||
- | Editors create user manuals, tutorials and Wiki pages. They also maintain the current information and check for grammar and spelling issues. | + | |
- | + | ||
- | Since LibreCAD is used all over the world, the English | + | |
- | + | ||
- | ==== Need for architects ==== | + | |
- | The architects focus on **how the information is organized and presented**. This is not only making the information more presentable and better organized, | + | There is a specific way to // |
- | ==== If you are a new editor/ | + | ===== Contributors ===== |
- | Depending on which part of the document you want to contribute, you will need to create the following accounts: | + | As an open source software, LibreCAD lives through community contributions. It is not possible |
- | * [[http://forum.librecad.org/|LibreCAD | + | * LibreCAD 2 [[https://github.com/LibreCAD/LibreCAD/graphs/contributors|code developers]] |
- | * [[https://librecad.zulipchat.com|Zulip chat]]: recommended as information are shared and discussed. It also allows direct messages to someone or everyone to share issues, proposal and to coordinate. | + | * LibreCAD 2 [[https:// |
- | * [[https:// | + | * LibreCAD 3 [[https://github.com/LibreCAD/LibreCAD_3/graphs/ |
- | * DokuWiki: if you wish to contribute to this Wiki, to tutorials, etc. | + | We should also mention all // |
+ | **Thank you all !** | ||