diff --git a/contributors_manual/community.rst b/contributors_manual/community.rst new file mode 100644 --- /dev/null +++ b/contributors_manual/community.rst @@ -0,0 +1,92 @@ +.. meta:: + :description: + Guide to the Krita community + +.. metadata-placeholder + + :authors: - Boudewijn Rempt + :license: GNU free documentation license 1.3 or later. + +.. index:: community, communication + +.. _the_krita_community: +=================== +The Krita Community +=================== + +Get in touch! Apart from the website at https://www.krita.org, the Krita project has three main communication channels: + +* Internet Relay Chat (IRC) +* The mailing list +* Phabricator + +While Krita developers and users are present on social media such as Twitter, Mastodon, Reddit, Google+, Tumblr or Facebook, those are not the place where we discuss new features, bugs, development or where we make plans for the future. + +There are also the: + +* bug tracker +* development sprints + +You’ll find that there are a number of people are almost always around: the core team. + +* Boudewijn (irc: boud): project maintainer, lead developer. Works full-time on Krita. Manages the Krita Foundation, triages bugs, does social media and admin stuff. +* Dmitry (irc: dmitryk_log): lead developer. Works full-time on Krita. +* Wolthera (irc: wolthera_laptop): developer, writes the manual and tutorials, triages bugs, helps people out +* Scott Petrovic (irc: scottyp): UX designer, developer, webmaster +* David Revoy (irc: deevad): expert user, creates Pepper & Carrot, maintains the preset bundle. +* Alvin Wong (irc: windragon): windows guru +* Ben Cooksley (irc: bcooksley): KDE system administrator. + +Krita’s team spans the globe, but most development happens in Europe and Russia. + +Krita is part of the larger KDE community. The KDE® Community is a free software community dedicated to creating an open and user-friendly computing experience, offering an advanced graphical desktop, a wide variety of applications for communication, work, education and entertainment and a platform to easily build new applications upon. The KDE contributors guide is relevant for Krita contributors, too, and can be found here: http://archive.flossmanuals.net/kde-guide/ . + +The Krita Foundation was created to support development of Krita. The Krita Foundation has sponsored Dmitry’s work on Krita since 2013. + +Internet Relay Chat +------------------- + +IRC is the main communication channel. There are IRC clients for every operating system out there, as well as a web client on the krita website. + +* Joining IRC: connect to irc.freenode.net, select a unique nickname and join the #krita and ##krita-chat channels. #krita is for on-topic talk, ##krita-chat for off-topic chat. +* Don’t ask to ask: if you’ve got a question, just ask it . +* Don’t panic if several discussions happen at the same time. That’s normal in a busy channel. +* Talk to an individual by typing their nick and a colon. +* Almost every Monday, at 14:00 CET or CEST, we have +a meeting where we discuss what happened in the past week, what we’re doing, and everything that’s relevant for the project. r The meeting notes are kept in google docs. +* Activity is highest in CET or CEST daytime and evenings. US daytime and evenings are most quiet. +* **IRC is not logged. If you close the channel, you will not be gone, and you will not be able to read what happened when you join the channel again. If you ask a question, you have to stay around!** +* It is really irritating for other users and disrupting to conversations if you keep connecting and disconnecting. + + +Mailing List +------------ + +The mailing list is used for announcements and sparingly for discussions. Everyone who wants to work on Krita one way or another should be subscribed to the mailing list. + +* https://mail.kde.org/mailman/listinfo/kimageshop +The mailing list is called “kimageshop: because that is the name under which the Krita project was started. Legal issues (surprise!) led to two renames, once to Krayon, then to Krita. + + +Phabricator +----------- + +Phabricator serves the following purposes for the Krita team: + +* Track what we are working on: https://phabricator.kde.org/maniphest/ This includes development tasks, designing new features and UX design, as well as tasks related to the website. +* Review code submissions: https://phabricator.kde.org/differential/ +* Host the git repository: https://phabricator.kde.org/source/krita/ . Note that while there is a mirror of our git repository on Github, we do not use Github for Krita’s development. + +**Do not** report bugs as tasks on Phabricator. Phabricator is where we organize our work. + +**Do** put all your code submissions (patches) on Phabricator. **Do not** attach patches to bugs in the bug tracker. + +Bugzilla: the Bug Tracker +------------------------- + +Krita shares the bug tracker with the rest of the KDE community. Krita bugs are found under the Krita product. There are two kinds of reports in the bug tracker: bugs and wishes. See the chapters on Bug Reporting and Bug Triaging on how to handle bugs. Wishes are feature requests. Do not report feature requests in bugzilla unless a developer has asked you to. See the chapter on Feature Requests for what is needed to create a good feature request. + +Sprints +------- + +Sometimes, core Krita developers and users come together, most often in Deventer, the Netherlands, to work together on our code design, UX design, the website or whatever needs real, face-to-face contact. Travel to sprints is usually funded by KDE e.V., while accommodation is funded by the Krita Foundation. diff --git a/contributors_manual/untranslatable_pages/triaging_bugs.rst b/contributors_manual/untranslatable_pages/triaging_bugs.rst new file mode 100644 --- /dev/null +++ b/contributors_manual/untranslatable_pages/triaging_bugs.rst @@ -0,0 +1,166 @@ +.. meta:: + :description: + Manual for bug triagers + +.. metadata-placeholder + + :authors: - Boudewijn Rempt SAFE ASSERT (krita): "!sanityCheckPointer.isValid()" in file /tmp/nix-build-krita-4.0.0-pre2c.drv-0/krita-1b1695a/libs/ui/KisDocument.cpp, line 490''' + +Or another mention of assert, Q_ASSERT or similar, it's an assert, not a crash. + +Canned Answers and Recognizing Common Reports +--------------------------------------------- + +We get a lot of duplicate bug reports. Sometimes it's clear that it's a duplicate, and you can mark it a such. In all cases, we want to give the reporter useful information so they can solve their problems. Of course, (almost) all solutions are also in the FAQ, but just pointing people to the FAQ is often considered impolite. + +So, do never reply to a bug report with + +* "Just read the FAQ." + +It takes a bit of experience to recognize a bug from an often incomplete description. Here are a couple of common cases: + +Cannot Save +^^^^^^^^^^^ + +For instance: +"I cannot save/my file doesn't get saved/it says it cannot copy the file" + +This happens most often on Windows, if the user has got any security software installed that doesn't come with Windows. Examples are Sandboxie, Totaldefender, orothers. Mark the bug as NEEDSINFO, WAITINGFORINFO and add this text: + +* "Are you using Windows? If so, do you have any non-standard security software installed such as Total Defender, Sandboxie or XXX? Please make an exception for Krita in the settings, or uninstall this software. Since Windows 10, it is no longer necessary to have any security software installed other than what comes with Windows." + +If the user replies that they are using extra security software, close the bug as "RESOLVED, INVALID". + +Broken Canvas +^^^^^^^^^^^^^ + + +This happens on Windows. Symptoms will be: the canvas is black, the canvas stays blank, the canvas only updates when the user clicks outside the canvas. Mark the bug as a duplicate of https://bugs.kde.org/show_bug.cgi?id=360601, and add the following text: + +* "You probably are using a Windows system with an Intel display chip. Please update to Krita 3.3.3, which enables the Direct3D (Angle) renderer by default. If you do not want to update, check https://docs.krita.org/KritaFAQ#Krita_starts_with_a_black_or_blank_canvas_and_nothing_changes_when_you_try_to_draw.2Fshows_a_black_or_blank_screen_on_my_Windows_system_with_an_Intel_GPU ." + +My stylus has an offset +^^^^^^^^^^^^^^^^^^^^^^^ + +This happens on Windows. Symptoms will be: the user reports that the stylus cursor has an offset or moves the cursor on another screen. Usually, the user will have a misconfigured multi-monitor system. Mark the bug as NEEDSINFO, WAITINGFORINFO and ask the user: + +* "Do you have a multi-monitor setup? If so, this is a configuration issue. Please reset your tablet driver's configuration and Krita's configuration (https://docs.krita.org/en/KritaFAQ.html#resetting-krita-configuration). If you have a single-monitor setup, then please calibrate your tablet." + +If the user checks back and tells us the problems are solved, mark the bug as RESOLVED,UPSTREAM. + +Other tablet issues +^^^^^^^^^^^^^^^^^^^ + +Often, the user will tell you that their tablet will work perfectly with another application. This is not relevant. Tell the user: + +* "Windows tablet drivers often have special code for different applications. Whether an application works or not depends on whether the programmers have tested their driver with an application or not. Tablet issues are almost always caused by the drivers being broken." + +Krita lags +^^^^^^^^^^ + +The word "lag" is meaningless. Complaints about "lag" are not bug reports. However, we should help the complainer. + +Mark the bug as NEEDSINFO/WAITINFORINFO and ask the user" + +* "Have you enabled the stabilizer? Check the tool options panel for the freehand tool. Also check the other possibilities mentioned here: https://docs.krita.org/KritaFAQ#Krita_is_slow" + +I cannot paint at all, in a particular document +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The user probably created, accidentally, a tiny selection, and saved that with the document. Mark as NEEDSINFO/WAITINGFORINFO and ask them: + +* "Do you have a selection saved with that document. Use select/deselect on your image and check whether you can paint again. If not, please attach the .kra document to this bug report or make it available."