Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
contribute:start [2018/11/12 23:50] – [Contribute] alexxcons | contribute:start [2023/02/06 08:16] – fix Donations link kevinbowen |
---|
| ~~NOTOC~~ |
| {{ :xfce-64x64.png?nolink|}} |
| ====== How to contribute to Xfce ====== |
| Xfce is developed by a small group of hard-working volunteers. There are many ways in which you can contribute to Xfce, all of which are most welcome! |
| |
====== Contact ====== | For a more in-depth look at how to contribute to Xfce, it is recommended to read [[https://andreldm.com/2018/12/03/xfce-contributor-guide.html|The Ultimate Contributor's Guide to Xfce]] for additional helpful information. |
Before starting contribution it may make sense to get in contact with some xfce experts: | |
| |
* via [[https://en.wikipedia.org/wiki/Internet_Relay_Chat|IRC]]: Join #xfce and #xfce4-dev on Freenode | If you would like to donate to Xfce, please see the [[start#Financial Contributions|Donations]] section. |
* via some [[https://mail.xfce.org/mailman/listinfo| Xfce mailing list]] - first check if the list is still active ! | |
| |
It as well helps to check the current roadmap in the [[https://wiki.xfce.org/|Xfce development Wiki]] in order to get an overview of the currently ongoing development. | * **[[#Bug Reporting and Testing|Bug Reporting and Testing]]** |
| * **[[#Communication|Communication]]** |
| * **[[#Development|Development]]** |
| * **[[#Documentation|Documentation]]** |
| * **[[#Financial Contributions|Financial Contributions]]** |
| * **[[#Feature Requests|Feature Requests]]** |
| * **[[#Translation|Translation]]** |
| |
====== Contribute ====== | ---- |
| |
There are different ways in which you can contribute to xfce: | ===== Bug Reporting and Testing ===== |
| |
* [[.:translate/start|Translation]] - Translate Xfce applications into different languages. | One of the most useful tasks that we rely on the community for is testing and reporting of bugs. |
| |
* [[documentation|Documentation]] - add or translate application manuals on this website. | * You can report bugs on [[https://gitlab.xfce.org/|Xfce GitLab site]] |
| |
* [[.:bugs/start|Bugs]] - report or fix Xfce bugs, provide new features | * You can ask on our IRC channel [[irc://irc.libera.chat/#xfce|#xfce on Libera.chat]] for help. A [[https://web.libera.chat/#xfce|web irc interface]] is also available if you don't have an irc client. |
| |
* [[https://www.bountysource.com/teams/xfce|Bountysource]] - Put some money on bugs you want to have fixed | |
* [[https://www.bountysource.com/teams/xfce|{{https://www.bountysource.com/badge/team?team_id=849&style=raised&.jpg?}}]] - as well possible to put a general donation | |
| |
Once you did some contributions, you may want to grab extra permissions to e.g. release your modifications: | * Please do not use the forums to report bugs. |
| |
* [[.:dev/start|becoming a xfce-developer]] - contributor account, git access, releases | Before submitting a bug, please try your best to check if it has already been reported. When writing your bug report, try to be as descriptive as possible, but avoid verbosity; Mozilla has a nice guide on [[https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines|how to write a bug report]]. |
| |
Xfce API documentation can be found in the [[https://wiki.xfce.org/api_documentation| Developer Wiki]] | For more information, see [[.:bugs/start|Bug Reporting and Fixing]]. |
| |
===== API documentation ===== | |
| |
Library references can be found in the releases: [[http://archive.xfce.org/src/xfce/garcon|garcon]], [[http://archive.xfce.org/src/xfce/exo|exo]], [[http://archive.xfce.org/src/xfce/libxfce4ui|libxfce4ui]], [[http://archive.xfce.org/src/xfce/libxfce4util|libxfce4util]], [[http://archive.xfce.org/src/xfce/thunar|thunar]], [[http://archive.xfce.org/src/xfce/xfconf|xfconf]]. They are often also installed by distributions in ''/usr/share/gtk-doc/html/''. | * For a list of currently open bugs, see the [[:contribute:bugs:bug-summary|open bugs summary]]. |
| |
Additionally, Xfce uses the GTK+/Glib family of libraries which can be found at the following: | If you want to test the current state of Xfce 4.16, you can look at the [[https://wiki.xfce.org/testing/xfce-test|Xfce-Test Quick Start Guide]], which provides instructions for running a Docker container with the lastest code from git master as well as the ability to run [[https://github.com/behave/behave|Behave]] (behaviour-driven development) tests. |
| |
* [[https://developer.gnome.org/glib/2.30/|GLib]] | * As of November 2020, OpenSUSE is now providing a source for "Xfce’s latest builds based on openSUSE’s rolling release Tumbleweed". This is available as a QEMU based virtual machine. |
* [[https://developer.gnome.org/gio/2.30/|GIO]] | * [[https://news.opensuse.org/2020/11/23/xfce-raw-images/|Xfce Virtual Machine Images For Development]] provides additional information for its installation and bug reporting instructions. |
* [[https://developer.gnome.org/gdk2/2.24/|GDK]] | |
* [[https://developer.gnome.org/gtk2/2.24/|GTK+]] | |
| |
Tutorials for getting started with GTK+ are available at: | ---- |
| |
* [[http://zetcode.com/tutorials/gtktutorial/|GTK+ Tutorial]] | ===== Communication ===== |
* [[https://developer.gnome.org/gtk-tutorial/2.24/|GTK+ 2.0 Tutorial (Official)]] | There are various ways to get in touch with Xfce developers: |
| |
If you're looking at writing a panel plugin, you may want to look at the [[http://git.xfce.org/panel-plugins/xfce4-sample-plugin/|xfce4-sample-plugin]] for an easy start. | See the [[https://docs.xfce.org/contribute/dev/start#communicating_with_the_xfce_development_team|Xfce Development Information]] page for information on contacting the Xfce development team. |
| |
| ---- |
| |
| ===== Development ===== |
| |
| See the [[:contribute:dev:start|Xfce Development Information]] page for details on getting a contributor's account, working with Git and Xfce source code, and instructions for making releases. |
| As well check the [[https://wiki.xfce.org/|Xfce Wiki]] more development hints, tips and tricks. |
| |
| ---- |
| |
| ===== Documentation ===== |
| |
| The [[https://wiki.xfce.org/|Xfce Wiki]] and [[https://docs.xfce.org/|Documentation]] contain many helpful pages that require maintaining and updating with every new release. The wiki is freely available for anyone to edit, refer [[documentation|here]] for information on how to contribute to the documentation. |
| The [[https://developer.xfce.org/|API reference]] is automatically updated on a weekly basis based on the latest stable releases. |
| |
| ---- |
| |
| ===== Financial Contributions ===== |
| |
| As of May 2021, Xfce has moved its fiscal hosting to OpenCollective. We are now able to accept financial contributions in both US Dollars as well as Euros. |
| If you wish to donate to Xfce in USD or with PayPal, you can do so by visiting [[https://www.opencollective.com/xfce/donate|Xfce’s OpenCollective page]]. Alternatively, if you wish to contribute in Euros, visit [[https://www.opencollective.com/xfce-eu/donate|Xfce’s EU OpenCollective page]]. Every donation is greatly appreciated, but please remember, this is an open source project that is 100% run by volunteers, no one is implicitly obliged to act upon your requests. |
| |
| For contributions in USD (SWIFT transfers / PayPal / credit card): |
| |
| [[https://opencollective.com/xfce/donate|{{:contribute:oc_donate_button30px.png}}]] |
| Note: For financial contributions to the Xfce Collective, there is a 10% transaction fee. |
| |
| For contributions in EUR (SEPA transfers / credit card): |
| |
| [[https://opencollective.com/xfce-eu/donate|{{:contribute:oc_donate_button30px.png}}]] |
| Note: For financial contributions to the Xfce (EU) Collective, there is a 6% transaction fee. Additionally, SEPA transfers may take several business days to process and will not appear in the transaction records immediately. |
| |
| For a list of our supporters and details on individual transactions, see our [[supporters|Supporters page]]. |
| |
| ---- |
| |
| ===== Feature Requests ===== |
| |
| Although the philosophy of Xfce is to find the correct balance between features and lightweight, it is still possible to request new features. |
| |
| If you plan to request a new feature, please first check on our [[https://gitlab.xfce.org/xfce|issue tracker]] if someone else already filed a request for it. If not, open a new issue and describe your idea in detail. Be warned: You might think your idea is brilliant, but there is a high possibility that there are major downsides. |
| |
| Obviously, the best way to get your new feature integrated is, to provide a merge request that implements it ! |
| |
| Please note that some components are rather unmaintained, so you might not always get a reply. |
| |
| ---- |
| |
| ===== Translation ===== |
| |
| Applications, manuals, documentation and many other aspects of Xfce are all translated into different languages. Translations are handled in [[https://www.transifex.com/xfce/public|Transifex]], a web-based translation platform. Visit the [[.:translate/start|translation docs]] to get started with translating. |
| |
| [[|Back To Top]] |
| ---- |
| [[:start|Back to main Xfce documentation page]] |