Project

General

Profile

Bug #14886 ยป contributing-rm-changelog.patch

jeremyevans0 (Jeremy Evans), 06/17/2019 10:51 PM

View differences:

doc/contributing.rdoc
380 380
* ABBRs should be all upper case.
381 381
* Do as others do
382 382

  
383
=== ChangeLog
383
=== Commit messages
384 384

  
385
Although not required, if you wish to add a ChangeLog entry for your change
386
please note:
385
When you're ready to commit:
387 386

  
388
You can use the following template for the ChangeLog entry on your commit:
387
   git commit path/to/files
389 388

  
390
  Thu Jan  1 00:00:00 2004  Your Name  <yourmail@example.com>
389
This will open your editor in which you write your commit message.
390
Use the following style for commit messages:
391 391

  
392
  	* filename (function): short description of this commit.
393
  	  This should include your intention of this change.
394
  	  [bug:#number] [mailinglist:number]
392
* Use a succint subject line.
393
* Include reasoning behind the change in the commit message, focusing on why
394
  the change is being made.
395
* Refer to redmine issue (such as Fixes [Bug #1234] or Implements
396
  [Feature #3456]), or discussion on the mailing list
397
  (such as [ruby-core:12345]).
398
* For GitHub issues, use [GH-#] (such as [Fixes GH-234]).
399
* Follow the style used by other committers.
395 400

  
396
  	* filename2 (function2): additional description for this file/function.
397

  
398
This follows {GNU Coding Standards for Change
399
Logs}[http://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs],
400
some other requirements and tips:
401

  
402
* Timestamps must be in JST (+09:00) in the style as above.
403
* Two spaces between the timestamp and your name. Two spaces between
404
  your name and your mail address.
405
* One blank line between the timestamp and the description.
406
* Indent the description with TAB. 2nd line should begin with TAB+2SP.
407
* Write a entry (*) for each change.
408
* Refer to redmine issue or discussion on the mailing list.
409
* For GitHub issues, use [GH-#] (such as [Fixes GH-234]
410
* One blank line between entries.
411
* Do as other committers do.
412

  
413
You can generate the ChangeLog entry by running <code>make change</code>
414

  
415
When you're ready to commit, copy your ChangeLog entry into the commit message,
416
keeping the same formatting and select your files:
417

  
418
    git commit ChangeLog path/to/files
419

  
420
In the likely event that your branch becomes outdated, you will have to update
421
your working branch:
422

  
423
    git fetch origin
424
    git rebase remotes/origin/master
401
=== Contributing your code
425 402

  
426 403
Now that you've got some code you want to contribute, let's get set up to
427 404
generate a patch. Start by forking the github mirror, check the {github docs on
......
453 430
command to generate patch files to upload to redmine.  You may also use
454 431
the {'git request-pull'}[https://git-scm.com/docs/git-request-pull] command for
455 432
formatting pull request messages to redmine.
433

  
434
=== Updating the official repository
435

  
436
If you are a committer, you can push changes directly into the official
437
repository:
438

  
439
    git push origin your-branch-name:master
440

  
441
However, it is likely will have become outdated, and you will have to
442
update it.  In that case, run:
443

  
444
    git fetch origin
445
    git rebase remotes/origin/master
446

  
447
and then try pushing your changes again.
456
-