I see very useful that template proposed by Ladislav. It could help quite a lot for reviewers and everyone interested in the PR (e.g., release managers or QA people). I am starting with something similar, see [1] and [2]. Definitely, I think this is better than a simple link to internal Trello card. [1] https://github.com/openSUSE/libstorage-ng/pull/611 [2] https://github.com/yast/yast-storage-ng/pull/834 On 1/18/19 12:28 PM, Ladislav Slezak wrote:
Dne 16. 01. 19 v 22:18 Fraser_Bell napsal(a):
On 1/16/19 8:04 AM, Josef Reidinger wrote:
Hi, I just noticed that our documentation team has quite nice pull request templates, that say them important info and also add notices to not forget check few things before you send pull request.[1] I found it quite useful. Maybe it makes sense to have something similar also for yast, as at least me often forget to at least write link to trello.
A Trello link is useless for external people, I prefer writing bugzilla links. Many of them can be read by external people and a Trello link is usually included there anyway.
I think that would be a great idea, Josef. Especially for the newbie YaST people such as myself.
We already have a CONTRIBUTING.md file [1] in each YaST repository, I think a link to it is displayed when opening a pull request.
In the pull request template I'd prefer something like this:
------------------------------------------------------------
## Problem
*Short description of the original problem.*
- *Bugzilla link* - *openQA link* - *Links to other related pull requests*
## Fix
*Short description of the fix.*
## Testing
- *Added a new unit test* - *Tested manually*
## Screenshots
*If the fix affects the UI attach some screenshots here.*
------------------------------------------------------------
What do you think about it? Would that be useful for you?
[1] https://github.com/yast/yast-yast2/blob/master/CONTRIBUTING.md
--
Best Regards
Ladislav Slezák Yast Developer ------------------------------------------------------------------------ SUSE LINUX, s.r.o. e-mail: lslezak@suse.cz Lihovarská 1060/12 tel: +420 284 028 960 190 00 Prague 9 fax: +420 284 028 951 Czech Republic http://www.suse.cz/
-- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org