Changes between Version 12 and Version 13 of CodingGuidelines/SubmittingPatches


Ignore:
Timestamp:
May 31, 2017, 12:12:21 PM (7 years ago)
Author:
korli
Comment:

typo

Legend:

Unmodified
Added
Removed
Modified
  • CodingGuidelines/SubmittingPatches

    v12 v13  
    44By default, tickets are assigned to a default component owner. If you wish to work on an assigned ticket, simply comment on the ticket to inform the person. For the most part, this is to reduce the frustration of duplicating work.
    55
    6 === Automatic whitespace cleanup ===
    7 Sometimes you'll see a commit message of "Automatic whitespace cleanup. No functional change.", for example r36509. It is preferred for new code to not introduced unneeded whitespace. Luckily, there is an option in Pe to perform this for you automatically. Here is how to enable it from within Pe.
     6=== Automatic white space cleanup ===
     7Sometimes you'll see a commit message of "Automatic white space cleanup. No functional change.", for example r36509. It is preferred for new code to not introduced unneeded white space. Luckily, there is an option in Pe to perform this for you automatically. Here is how to enable it from within Pe.
    88 * In the menu bar, select Window --> Preferences
    99 * Select "Files" from the left pane
     
    1616 * Create patches from within the ''HAIKU_TOP'' directory. This is the directory that contains ''configure'' and typically is the ''haiku/'' or ''buildtools/'' branch.
    1717        * {{{ git status }}} will display which files are modified, added, or deleted. Use `git diff` to inspect your changes.
    18         * You'll then have to commit the patch locally by adding the changed or added files (`git add my-file my/new/file`), and then do a `git commit`. You will need to enter a complete commit message that will later appear as is in Haiku's repository if your patch is going to be accepted. The first line of the message is the title that should be as discriptive as possible while not exceeding 50 characters. After an empty line you should add a detailed description what you're trying to fix and how. If you solve a ticket in the bugtracker with it, add a "Fixes #{ticketnumber}" at the end.
     18        * You'll then have to commit the patch locally by adding the changed or added files (`git add my-file my/new/file`), and then do a `git commit`. You will need to enter a complete commit message that will later appear as is in Haiku's repository if your patch is going to be accepted. The first line of the message is the title that should be as descriptive as possible while not exceeding 50 characters. After an empty line you should add a detailed description what you're trying to fix and how. If you solve a ticket in the bugtracker with it, add a "Fixes #{ticketnumber}" at the end.
    1919        * Now, you need to create the actual patch file that you can, for example, attach to a ticket:
    2020                * `git format-patch <commitsha or branch name>` - this will create a file named 0001-your-commit-message.patch. (Note: Depending on your workflow, `git format-patch HEAD~1` may also suffice)