Add doc on how to process and triage I18n bugs
Change-Id: I7ddd7cb7c2194d35f057246258fe69326e47a51e
This commit is contained in:
parent
06040638bd
commit
0b5aad01fe
85
doc/source/bug_process.rst
Normal file
85
doc/source/bug_process.rst
Normal file
@ -0,0 +1,85 @@
|
||||
===================================
|
||||
Bug management process in Launchpad
|
||||
===================================
|
||||
|
||||
This page describes how to process bugs.
|
||||
|
||||
I18n related bugs are managed by Launchpad.
|
||||
The bug triaging process are following the
|
||||
`general bug triaging process <https://wiki.openstack.org/wiki/BugTriage>`_
|
||||
If you want to help bug triaging tasks, join the
|
||||
`OpenStack I18n bug team <https://launchpad.net/~openstack-i18n-bugs>`_
|
||||
firstly.
|
||||
|
||||
Besides the general bug triaging process, there are typical
|
||||
questions in I18n bug triaging process.
|
||||
|
||||
How to categorize bugs and tag bugs?
|
||||
------------------------------------
|
||||
|
||||
The bug could be categorized by the content or by the related projects
|
||||
|
||||
* If a bug reports an error related to OpenStack Dashboard,
|
||||
it is related to Horizon project. It should be tagged with "horizon".
|
||||
* If a bug reports an error related to OpenStack Manuals,
|
||||
it is related to Docs project. It should be tagged with "docs".
|
||||
* If a bug reports bad translations of a certain language,
|
||||
it could be called "translation bug".
|
||||
It should be tagged with the language name.
|
||||
* If a bug reports a missing translation of a certain language,
|
||||
and it is related to Horizon project, it might be a "translation bug",
|
||||
or a "source code bug".
|
||||
"Source code bug" should be tagged with the project name.
|
||||
|
||||
How to handle a missing translation bug?
|
||||
----------------------------------------
|
||||
|
||||
You must determine whether the bug is a translation bug or a source code
|
||||
bug firstly.
|
||||
|
||||
If the bug is related to OpenStack Dashboard, go to OpenStack Dashboard,
|
||||
change the setting to another language, and verify if the translation is
|
||||
still missing.
|
||||
|
||||
If the translation is missed in two different languages, that might be a
|
||||
"source code bug". Or else, it might be a "translation bug".
|
||||
Then you could handle it as described in "How to handle a translation bug ?"
|
||||
or "How to handle a source code bug ?"
|
||||
|
||||
How to handle a translation bug?
|
||||
--------------------------------
|
||||
|
||||
The translation bug should be fixed in the translation tool - Zanata.
|
||||
If you are a speaker of this language, you could help
|
||||
|
||||
* tag the bug with a language name
|
||||
* confirm the bug or mark it as incomplete
|
||||
* prioritize the bug
|
||||
|
||||
If you are a translator of this language, you could help
|
||||
|
||||
* assign the bug to you or a member of your language team,
|
||||
and then mark it as "In Progress"
|
||||
* fix it in Zanata
|
||||
|
||||
How to handle a source code bug ?
|
||||
---------------------------------
|
||||
|
||||
The source code bug shoud be fixed in the source code project.
|
||||
You coude determine which project it is related to. You could
|
||||
|
||||
* tag it with the project name, for example "horizon" or "docs"
|
||||
* add the related project to "Also affects project" of this bug
|
||||
* confirm the bug
|
||||
* prioritize the bug
|
||||
|
||||
If you are able to fix the error in the source code,
|
||||
go to the source code project to fix it.
|
||||
And then, we also need to fix translations in Zanata.
|
||||
|
||||
How to handle bugs written in a non-English language?
|
||||
-----------------------------------------------------
|
||||
|
||||
I18n accepts bugs written in a non-English language.
|
||||
If you could read the bug description, help to translate the key point
|
||||
into English and triage the bug.
|
@ -20,6 +20,7 @@ Contents
|
||||
|
||||
contributing
|
||||
bug_report
|
||||
bug_process
|
||||
handling_bugs
|
||||
official_translator
|
||||
create_lang_team
|
||||
|
Loading…
Reference in New Issue
Block a user