mirror of
https://gh.wpcy.net/https://github.com/WeblateOrg/weblate.git
synced 2026-04-27 15:15:46 +08:00
f5582adf91
Use labels to track issue state so that the state can be easily read from the issue tracker. Co-authored-by: AliceVisek <alice@weblate.org>
103 lines
4.8 KiB
ReStructuredText
103 lines
4.8 KiB
ReStructuredText
.. _report-issue:
|
||
|
||
Reporting issues in Weblate
|
||
===========================
|
||
|
||
Weblate `issue tracker <https://github.com/WeblateOrg/weblate/issues>`_ is hosted at GitHub.
|
||
|
||
Feel welcome to report any issues you have or suggest improvements for Weblate there.
|
||
There are various templates prepared to comfortably guide you through the issue report.
|
||
|
||
If what you have found is a security issue in Weblate, please consult
|
||
the :ref:`security` section below.
|
||
|
||
If you are not sure about your bug report or feature request, you can try :ref:`discussions`.
|
||
|
||
Issues lifecycle
|
||
----------------
|
||
|
||
|
||
.. graphviz::
|
||
|
||
digraph "Issue lifecycle" {
|
||
graph [fontname = "sans-serif", fontsize=10, ranksep=0.6, newrank=true];
|
||
node [fontname = "sans-serif", fontsize=10, margin=0.15];
|
||
edge [fontname = "sans-serif", fontsize=10];
|
||
|
||
subgraph cluster_states {
|
||
graph [color=white];
|
||
"Waiting for: Triage" [shape=box, fillcolor="#1fa385", fontcolor=white, style=filled];
|
||
"Waiting for: Demand" [shape=box, fillcolor="#1fa385", fontcolor=white, style=filled];
|
||
"Waiting for: Community" [shape=box, fillcolor="#1fa385", fontcolor=white, style=filled];
|
||
"Waiting for: Milestone" [shape=box, fillcolor="#1fa385", fontcolor=white, style=filled];
|
||
"Waiting for: Implementation" [shape=box, fillcolor="#1fa385", fontcolor=white, style=filled];
|
||
"Waiting for: Release" [shape=box, fillcolor="#1fa385", fontcolor=white, style=filled];
|
||
}
|
||
|
||
"Issue created" [fillcolor="#144d3f", fontcolor=white, style=filled];
|
||
"Issue closed as not planned" [fillcolor="#cccccc", style=filled];
|
||
"Issue converted to a discussion" [fillcolor="#cccccc", style=filled];
|
||
"Issue resolved" [fillcolor="#144d3f", fontcolor=white, style=filled];
|
||
|
||
"Issue created" -> "Waiting for: Triage";
|
||
|
||
"Waiting for: Triage" -> "Waiting for: Community" [label="The issue is not clearly defined"];
|
||
"Waiting for: Triage" -> "Issue closed as not planned" [label="The issue is out of scope"];
|
||
"Waiting for: Triage" -> "Issue converted to a discussion" [label="The issue is merely a support request"];
|
||
"Waiting for: Triage" -> "Waiting for: Milestone" [label="Ready to to be worked on"];
|
||
|
||
"Waiting for: Community" -> "Waiting for: Triage" [label="Community feedback received"];
|
||
"Waiting for: Community" -> "Issue closed as not planned" [label="Lack of response"];
|
||
|
||
"Waiting for: Community" -> "Waiting for: Milestone" [label="Ready to to be worked on"];
|
||
"Waiting for: Community" -> "Waiting for: Demand" [label="Too narrow use case"];
|
||
"Waiting for: Demand" -> "Waiting for: Milestone" [label="Ready to to be worked on"];
|
||
"Waiting for: Demand" -> "Issue closed as not planned" [label="The issue is out of scope"];
|
||
"Waiting for: Milestone" -> "Waiting for: Implementation" [label="Milestone assigned issue will be worked on"];
|
||
"Waiting for: Implementation" -> "Waiting for: Release" [label="Issue implemented waiting for a release"];
|
||
"Waiting for: Release" -> "Issue resolved" [label="The solution for the issue has been released"];
|
||
|
||
}
|
||
|
||
.. _security:
|
||
|
||
Reporting security issues
|
||
-------------------------
|
||
|
||
Weblate’s development team is strongly committed to responsible reporting and
|
||
disclosure of security-related issues. We have adopted and follow policies that
|
||
are geared toward delivering timely security updates to Weblate.
|
||
|
||
Most normal bugs in Weblate are reported to our public `GitHub issues tracker
|
||
<https://github.com/WeblateOrg/weblate/issues>`_, but due to the sensitive
|
||
nature of security issues, we ask that they not be publicly reported in this
|
||
fashion.
|
||
|
||
Instead, if you believe you’ve found something in Weblate that has security
|
||
implications, please submit a description of the issue to security@weblate.org,
|
||
`GitHub <https://github.com/WeblateOrg/weblate/security/advisories/new>`_,
|
||
or using `HackerOne <https://hackerone.com/weblate>`_.
|
||
|
||
A member of the security team will respond to you within 48 hours, and
|
||
depending on what action is taken, you may get more follow-up emails.
|
||
|
||
.. note::
|
||
|
||
**Sending encrypted reports**
|
||
|
||
If you want to send an encrypted email (*optional*), please use the public
|
||
key for michal@weblate.org with ID ``3CB 1DF1 EF12 CF2A C0EE 5A32 9C27 B313
|
||
42B7 511D``. This public key is available on the most commonly used key servers,
|
||
and from `Keybase <https://keybase.io/nijel>`_.
|
||
|
||
.. hint::
|
||
|
||
Weblate depends on third-party components for many things. In case
|
||
you find a vulnerability affecting one of those components in general,
|
||
please report it directly to the respective project.
|
||
|
||
Some of these are:
|
||
|
||
* :doc:`Django <django:internals/security>`
|
||
* `Django REST framework <https://www.django-rest-framework.org/#security>`_
|
||
* `Python Social Auth <https://github.com/python-social-auth>`_
|
