This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
public:bug_reporting [2016/09/14 08:30] acorbi [Make sure that the Issue/Feature that you are raising has not been reported yet] |
public:bug_reporting [2017/10/17 07:00] acorbi [Issues should be filed on the github repository relating of the corresponding workstream] |
||
---|---|---|---|
Line 13: | Line 13: | ||
===== Things to know in forehand ===== | ===== Things to know in forehand ===== | ||
- | ==== Issues should be filed on the corresponding github repository ==== | + | ==== Issues should be filed on the github repository relating to the corresponding workstream ==== |
- | The code base of the ODM project is composed by several different code repositories found on https://github.com/OpenDevelopmentMekong/. Depending on what part of the system the bug report of feature request relates to, Issues should be raised in the corresponding github repostory. | + | Depending on what part of the system the bug report of feature request relates to, Issues should be raised in the corresponding github repostory. |
- | As a rule of thumb, issues relating to the frontend will be reported on https://github.com/OpenDevelopmentMekong/wp-odm_theme/ or https://github.com/OpenDevelopmentMekong/wpckan depending on whether it , CKAN issues on https://github.com/OpenDevelopmentMekong/ckanext-odm_dataset, https://github.com/OpenDevelopmentMekong/ckanext-odm_library or https://github.com/OpenDevelopmentMekong/ckanext-laws depending on the type of dataset. | + | In order to keep it simple. Issues should be raised in one of the following repositories. Each of them corresponding to one of the workstreams ODI's work is usually organized into: |
+ | |||
+ | [[https://github.com/OpenDevelopmentMekong/tech_workstream | Tech workstream]] Everything related to the platform's code-base. Bugs, general issues or feature requests for both WP front-end, CKAN back-end or any other component can be filed here. | ||
+ | |||
+ | [[https://github.com/OpenDevelopmentMekong/data_workstream | Data workstream]] Everything related to data work. Missing, incomplete or incorrect datasets. Requests of adding new datasets to the CKAN instance, etc.. | ||
+ | |||
+ | [[https://github.com/OpenDevelopmentMekong/editorial_workstream | Editorial workstream]] Everything related to the news articles, profiles, stories, etc... maintained on the WP instance. Missing or incorrect information, requests for adding a specific news article etc can be filled here | ||
+ | |||
+ | [[https://github.com/OpenDevelopmentMekong/localization_workstream | Localization workstream]] Everything related to the localization of the platform's components and contents into local languages. Issues related to the way strings are translated on transifex or issues encountered on the public-facing texts can be filled here. | ||
+ | |||
+ | {{:public:screenshot_from_2017-10-17_08-49-29.png?400|}} | ||
==== Some useful resources to read/watch before ==== | ==== Some useful resources to read/watch before ==== | ||
* https://www.youtube.com/watch?v=Ze_nGboSmZ4 | * https://www.youtube.com/watch?v=Ze_nGboSmZ4 | ||
+ | * https://blog.okfn.org/2017/04/26/oki-agile-how-to-create-and-manage-user-stories/ | ||
==== Make sure that the Issue/Feature that you are raising has not been reported yet ==== | ==== Make sure that the Issue/Feature that you are raising has not been reported yet ==== | ||
Line 44: | Line 55: | ||
Instead of informing of an error on the functionality, a feature request proposes the implementation of a new functionality or the improvement of an existing one. | Instead of informing of an error on the functionality, a feature request proposes the implementation of a new functionality or the improvement of an existing one. | ||
+ | |||
+ | While creating a github Issue with a feature requests please: | ||
+ | |||
+ | - Add design mockups on how you would like the feature to look like | ||
+ | - Provide detailed description on how the new feature should work and how the user is supposed to use it. | ||
+ | - Specify links on the pages/modules where the new feature should be implemented. | ||
===== Creating an issue on github containing the bug's or feature request details ===== | ===== Creating an issue on github containing the bug's or feature request details ===== |