| 1 |
On 01/24/2016 07:43 PM, Ulrich Mueller wrote: |
| 2 |
>>>>>> On Sun, 24 Jan 2016, Gokturk Yuksek wrote: |
| 3 |
> |
| 4 |
>> From: Michael Orlitzky <mjo@g.o> |
| 5 |
> |
| 6 |
>> The ChangeLog section under misc-files is misleading now that our main |
| 7 |
>> repository has been switched to git (and we no longer have |
| 8 |
>> ChangeLogs). Remove the ebuild-writing/misc-files/changelog page. |
| 9 |
> |
| 10 |
> Most of that section contains information that will still apply, even |
| 11 |
> if it no longer goes into a ChangeLog but a into a git commit message. |
| 12 |
> |
| 13 |
> Therefore the section shouldn't be removed, but rather be updated. |
| 14 |
> |
| 15 |
|
| 16 |
We will eventually need a "Commit Messages" page, but in my opinion the |
| 17 |
bar for these sorts of patches should be "does it make things better?" |
| 18 |
If so, merge it, and if you want to improve the result, do that. |
| 19 |
Otherwise nothing gets done. |
| 20 |
|
| 21 |
The ChangeLog page is nonsense as-is, and removing it makes the |
| 22 |
devmanual better. Afterwards, if someone wants to take the commit |
| 23 |
message guidelines from the wiki and merge them with the old ChangeLog |
| 24 |
tips, great. There's only two things worth salvaging from the ChangeLog |
| 25 |
page. Here's the combined list: |
| 26 |
|
| 27 |
1. Everything from the Git workflow wiki page "Commit message format" |
| 28 |
section. |
| 29 |
|
| 30 |
2. Mention the "Gentoo-Bug:" identifier. Using "bug #12345" in the |
| 31 |
commit message itself causes trouble. If you word-wrap on the |
| 32 |
"#12345", it will silently clobber the message. |
| 33 |
|
| 34 |
3. When including user-submitted ebuilds or patches, you should |
| 35 |
credit the user with his full name and email address (or |
| 36 |
whatever he uses to identify himself on bugzilla — some users |
| 37 |
prefer to be known only by a nickname). |
| 38 |
|
| 39 |
3.i. But use the "Reported-By:", "Suggested-By:", etc. mentioned on |
| 40 |
the wiki. |
| 41 |
|
| 42 |
4. If you are changing keywords, make sure you clearly state what |
| 43 |
keywords you add or remove. |
| 44 |
|
| 45 |
The bad examples at the end of the ChangeLog page are still bad, but the |
| 46 |
good examples are now bad too. There's not much worth saving. |
Archives