2019-02-26 09:09:52 +08:00
|
|
|
.. _bug_reporting:
|
|
|
|
|
|
|
|
|
|
Bug Reporting
|
|
|
|
|
##############
|
2019-02-14 03:22:40 +08:00
|
|
|
|
|
|
|
|
To maintain traceability and relation between proposals, changes, features, and
|
2019-02-26 09:09:52 +08:00
|
|
|
issues, it is recommended to cross-reference source code commits with the
|
|
|
|
|
relevant GitHub issues and vice versa.
|
|
|
|
|
Any changes that originate from a tracked feature or issue should contain a
|
|
|
|
|
reference to the feature by mentioning the corresponding issue or pull-request
|
|
|
|
|
identifiers.
|
2019-02-14 03:22:40 +08:00
|
|
|
|
|
|
|
|
At any time it should be possible to establish the origin of a change and the
|
|
|
|
|
reason behind it by following the references in the code.
|
2019-02-26 09:09:52 +08:00
|
|
|
|
