On 1/18/19 4:28 AM, 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?
Well, the md is probably all that is really needed. Since I am still
unsure of what I am doing, I cannot honestly say whether this is useful
or not in my case.
Although, it looks like it might be a good thing, but it could probably
just be added into the md?
If it is not making a lot of extra work for anyone to create that
template, though, it probably could improve the workflow at times.
It helps to give a little too much information instead of not enough, I
suppose.
Beats the heck out of scratching my head over an obscure 4-word
Documentation Line thinking: "Now, what in the world does that mean???"
LOL
--
-Gerry Makaro
openSUSE Board Elections Committee
(election-officials **at** openSUSE.org)
openSUSE Member
openSUSE Global Moderator
openSUSE Contributor
YaST Contributor
aka Fraser_Bell on the Forums, OBS, IRC, and mail at openSUSE.org
Fraser-Bell on Github
--
To unsubscribe, e-mail: [email protected]
To contact the owner, e-mail: [email protected]
