Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
contribute:start [2018/11/12 23:43] – [Contact] alexxcons | contribute:start [2019/09/07 03:05] – [Development] kevinbowen |
---|
| |
====== Contact ====== | ====== How to contribute to Xfce ====== |
Before starting contribution, usually it makes sense to get in contact with some xfce-developers: | 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! |
| |
* via [[https://en.wikipedia.org/wiki/Internet_Relay_Chat|IRC]]: Join #xfce and #xfce4-dev on Freenode | ===== Development ===== |
* 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. | 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. |
| |
| ===== 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. |
| |
====== Contribute ====== | ===== Donations ===== |
| If you wish to donate to Xfce, you can do so via [[https://www.bountysource.com/teams/xfce|Xfce’s Bountysource page]]. You can freely donate to the organization itself, or offer a reward to fix a specific bug. 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. |
| |
There are different ways in which you can contribute to xfce: | {{https://www.bountysource.com/badge/team?team_id=849&style=raised&.jpg?}} |
| |
* [[.:translate/start|Translation]] - Translate Xfce applications into different languages. | ===== Bug Reporting and Testing ===== |
| One of the most useful tasks that we rely on the community for is testing and reporting of bugs, you can report bugs on the [[https://bugzilla.xfce.org/|Xfce Bugzilla site]], the [[https://mail.xfce.org/mailman/listinfo/xfce-bugs|Xfce-bugs mailing list]], or you can ask on our IRC channel [[irc://irc.freenode.net/#xfce|#xfce on Freenode]] for help. Please do not use the forums to report bugs. 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]]. For more information, see [[.:bugs/start|Bug Reporting and Fixing]]. |
| |
* [[documentation|Documentation]] - add or translate application manuals on this website. | ===== 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. |
| |
* [[.:bugs/start|Bugs]] - report or fix Xfce bugs, provide new features | ===== Communication ===== |
| There are various ways to get in touch with Xfce developers: |
* [[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: | * For general questions, [[https://forum.xfce.org/|Xfce's Forum]], the [[https://mail.xfce.org/mailman/listinfo/xfce|Xfce mailing list]], and our IRC channel [[irc://irc.freenode.net/#xfce|#xfce on Freenode]] are the places to go. |
| * For any translation stuff, join the [[https://mail.xfce.org/mailman/listinfo/xfce-i18n|Xfce-i18n mailing list]]. |
| * For anything code related, go to the [[https://mail.xfce.org/mailman/listinfo/xfce4-dev|Xfce-dev mailing list]], or our IRC channel [[irc://irc.freenode.net/#xfce-dev|#xfce-dev on Freenode]]. |
| |
* [[.:dev/start|becoming a xfce-developer]] - contributor account, git access, releases | All Xfce developers have a real life and live across multiple time zones. If you don't get an answer straight away, be patient and stay online! |
| |
===== API documentation ===== | ===== Further Reading ===== |
| 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 more information. |
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/''. | |
| |
Additionally, Xfce uses the GTK+/Glib family of libraries which can be found at the following: | |
| |
* [[https://developer.gnome.org/glib/2.30/|GLib]] | |
* [[https://developer.gnome.org/gio/2.30/|GIO]] | |
* [[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]] | |
* [[https://developer.gnome.org/gtk-tutorial/2.24/|GTK+ 2.0 Tutorial (Official)]] | |
| |
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. | |
| |
| * To request a contributor account, please [[https://docs.xfce.org/contribute/dev/get-a-contributor-account|see the docs]] for more information. |
| * Before getting involved with development, it may help to check [[https://wiki.xfce.org/releng/4.14/roadmap|the current roadmap]] to get an overview of our current progress. |
| * A guide to using GIT can be found [[https://docs.xfce.org/contribute/dev/git/start|here]]. |
| * For more information on making a release, see [[https://docs.xfce.org/contribute/dev/make-a-release|Making a Release]]. |
| * Xfce API documentation can be found on the [[https://wiki.xfce.org/api_documentation|Xfce development Wiki]]. |