Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
contribute:start [2019/09/07 02:59] – added a section for development kevinbowen | contribute:start [2019/09/15 01:40] – [Feature Requests] added link to xfce-dev IRC channel kevinbowen |
---|
====== How to contribute to Xfce ====== | ====== 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! | 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! |
| |
| 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. |
| |
| If you would like to donate to Xfce, please see the [[start#Donations|Donations]] section. |
| |
| ===== 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]]. |
| |
| ===== Communication ===== |
| There are various ways to get in touch with Xfce developers: |
| |
| * 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]]. |
| |
| 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! |
| |
===== Development ===== | ===== Development ===== |
| |
* **[[:contribute:dev:get-a-contributor-account|Get a contributors account]]** -- Who can request a developers account and how to do so. | 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. |
| |
* **[[:contribute:dev:git:start|GIT]]** -- How to use the GIT DCVS; a short introduction and Xfce specific things you should know.\\ | ===== Documentation ===== |
| |
* **[[:contribute:dev:make-a-release|Making release tarballs]]** -- How to make releases, upload the tarballs and notify the world about it. | 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. |
| |
===== 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. | |
| |
===== Donations ===== | ===== 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. | 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. |
| |
{{https://www.bountysource.com/badge/team?team_id=849&style=raised&.jpg?}} | {{https://www.bountysource.com/badge/team?team_id=849&style=raised&.jpg?}} |
| |
===== Bug Reporting and Testing ===== | ===== Feature Requests ===== |
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 ===== | Although the philosophy of Xfce is to find the correct balance between features and lightweight, it is still possible to request new features. |
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. | |
| |
===== Communication ===== | The right approach for larger changes is to discuss them on the mailing list, or on our IRC channel [[irc://irc.freenode.net/#xfce-dev|#xfce-dev on Freenode]] first. You might think your idea is brilliant, but there is a high possibility that there are major downsides. |
There are various ways to get in touch with Xfce developers: | |
| |
* 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. | Afterwards a bug can be opened in the bug tracker. Make sure the //Importance// is set to //normal// and //enhancement//. |
* 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]]. | |
| |
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! | Obviously it would be nice if you could write a patch that implements the new feature. |
| |
===== Further Reading ===== | ===== Translation ===== |
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. | |
| 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. |
| |
* To request a contributor account, please [[https://docs.xfce.org/contribute/dev/get-a-contributor-account|see the docs]] for more information. | [[|Back To Top]] |
* 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]]. | |