| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| en:guides:contributor [2010/12/13 17:39] – pankso | en:guides:contributor [2026/10/14 23:29] (current) – external edit 127.0.0.1 |
|---|
| ====== Contributing to SliTaz ====== | ====== Contributing to SliTaz ====== |
| |
| There are so many ways you can help out with the SliTaz community. If you have a little free time, anything from artwork to package testing would be greatly appreciated! | SliTaz is made by volunteers and every hand is welcome. Introduce yourself on the [[https://maille.slitaz.org/|forum]] (Maille) and say what you would like to do. The handbook has a short [[https://doc.slitaz.org/handbook/help.html#contribute|Contributing]] section. |
| |
| Post a quick message to the forum or mailing list if you're unsure about anything. We don't bite! | ===== Testing ===== |
| |
| <note tip>We have a [[http://scn.slitaz.org/|Community Network]] where you can write blog posts, share wallpapers and images, and more. We encourage anyone that contributes to SliTaz to use this platform to show off their hard work!</note> | * Test development images published on [[https://lab.slitaz.org/|lab.slitaz.org]]. |
| | * Use **TazHelper** (on the dock, ''tazhelper'' in text mode): it runs automatic checks, guides you through a checklist and sends an anonymous test report. Manual: [[https://doc.slitaz.org/manuals/tazhelper/tazhelper.en.html|TazHelper]]. |
| | * Try packages from [[https://pkgs.slitaz.org/|pkgs.slitaz.org]] with ''spk-add'' and report what is broken. |
| |
| \\ | ===== Reporting bugs ===== |
| |
| ===== Developers & Hackers ===== | Open //Report a bug// (Filature report) from the dock or the Dash, describe the problem and send. In text mode: |
| |
| === Packaging === | <code> |
| | $ filature-report |
| | </code> |
| |
| If you are comfortable with the Linux compiling process (//configure, make, make install//), you can help by creating SliTaz packages. We have an automated tool to build packages from source called [[http://doc.slitaz.org/en:cookbook:wok|Tazwok]]. All SliTaz packages contain a [[en:cookbook:receipt|receipt]] - a text file where you control the building process using some variables and functions. You can browse the [[http://hg.slitaz.org/wok|wok]] to see some receipts and understand how they work. Please take time to read the [[en:cookbook:devcorner|Developer's]] page beforehand and practice locally with some new or existing packages. | Accepted reports become public bugs on [[https://filature.slitaz.org/bugs|filature.slitaz.org/bugs]]. See [[https://doc.slitaz.org/handbook/help.html#bugs|Handbook: Reporting a bug]]. For a question rather than a bug, use the forum and attach the output of ''trame system report''. |
| |
| When you feel ready to start cooking, read the [[http://labs.slitaz.org/wiki/13/Pkgscooklist|packages cooklist]], pick one and test. You can submit your receipts to the Mailing List or contact a SliTaz dev, so that we can review the work and give you access to the repos. | ===== Packaging ===== |
| |
| === Package Testing and Debugging === | Packages are built from //receipts//, small shell files, with cookutils: |
| |
| You can help SliTaz by testing packages and reporting bugs on the [[http://labs.slitaz.org/issues|Labs Issue Tracker]]. We have some [[http://labs.slitaz.org/wiki/packages|Package Testing Guidelines]]. You can use the testing project on the Labs, the forum or the mailing list to report any missing dependencies, unexpected package behavior, or wrong configurations, etc. | <code> |
| | # spk-add cookutils |
| | # cook setup --wok |
| | # cook new mypkg |
| | # nano /home/slitaz/wok/mypkg/receipt |
| | # cook mypkg |
| | </code> |
| |
| \\ | * [[https://doc.slitaz.org/handbook/build.html|Handbook: Build your own]] |
| | * [[https://doc.slitaz.org/manuals/cookutils/cookutils.en.html|Cookutils manual]] and [[https://doc.slitaz.org/manuals/cookutils/receipts-v2.html|receipt format v2]] |
| | * Official receipts: the wok on [[https://hg.slitaz.org/|hg.slitaz.org]]. Packages are built on [[https://cook.slitaz.org/|cook.slitaz.org]]. |
| |
| ===== Writers & Translators ===== | When a receipt builds and the package installs, send it to a developer or post it on the forum for review. |
| |
| Take a look at the [[:guidelines| SliTaz Documentation Guidelines]], pick your page and go! At this stage, we just need solid contributions which will then be reviewed and updated. We're undergoing a [[http://listengine.tuxfamily.org/lists.tuxfamily.org/slitaz/2010/04/msg00063.html|Summer of Documentation]], in which we're concentrating on all the docs. You'll be in good company. | ===== Code ===== |
| |
| There's many areas in which you can help: | The source of every tool, including the handbook, is in the Mercurial repositories on [[https://hg.slitaz.org/|hg.slitaz.org]]. Read the code, fix it, and send a patch or ask on the forum who maintains it. |
| |
| * **Are you experienced with SliTaz?** | ===== Translations and documentation ===== |
| Go for the Guides. They take users through a process and range from customising your desktop to getting networking set-up. If you've had success with a procedure or feel one could be improved, this is the place for you! | |
| |
| * **Are you a general Linux user?** | * [[https://doc.slitaz.org/handbook/|doc.slitaz.org]] is the official documentation, written by the developers. To improve the handbook, send a patch against the ''slitaz-doc'' repository or report what is wrong. |
| Take a look at the Handbook. A lot of general introduction to SliTaz, Linux or available software can be written there. Some people find it difficult to write technically, others struggle with more generically informative writing. Both are needed, in describing the topic and scope before brief instructions. | * This wiki holds community guides. Pick a page, check which release it was written for, and update it for 5.1. |
| | * Translations of the tools and of the handbook are welcome: ask on the forum which language and files need help. |
| * **Do you speak non-English?** | |
| Translations are very important to the global audience SliTaz attracts. We need speakers of the above languages to ensure non-English readers experience better translations than automated services can provide! Those are the locales supported by the SliTaz system. We are aiming to add more in the future -- if you can help, please do! | |
| | |
| \\ | |
| | |
| ===== Artists & Designers ===== | |
| | |
| [[http://community.slitaz.org/image/tid/2|Wallpapers]] make a huge impact on the first impression users receive. Some reviews barely comment further on artwork than the wallpaper! | |
| | |
| \\ | |
| | |
| ===== PR & Journalism ===== | |
| | |
| //(Could we put together some blurbs or short pieces of writing for the press & community? Maybe contacts for them?)// | |
| | |
| \\ | |
| | |
| | |
| ---- | |
| \\ | |
| ^ Page Review Section ^^ | |
| |Quality| Low | | |
| |Review| Major Updates FIXME | | |
| |Priority| High | | |
| |Problems| add a [[http://forum.slitaz.org|forum post link]]| | |
| |::: | OR add a [[http://labs.slitaz.org/issues |lab issue tracker link ]]| | |
| |How to Improve| Suggest briefly, e.g.,| | |
| |::: | [[en:guides:start | Add link]]| | |
| |::: | Add new rows like this ;-) | | |
| | |
| \\ | |
| ---- | |
| |
SliTaz Wiki