Changes between Version 15 and Version 16 of CodingGuidelines/SubmittingPatches


Ignore:
Timestamp:
Sep 4, 2018 3:47:36 PM (3 months ago)
Author:
humdinger
Comment:

Update URLs, add haiku-format note, remove advice on patches (not needed since Gerrit), remove note filing a ticket wrt email address (can be done by the user at Gerrit), removed humorous "public humiliation" (spoilsports :))

Legend:

Unmodified
Added
Removed
Modified
  • CodingGuidelines/SubmittingPatches

    v15 v16  
    55
    66=== Coding style ===
    7 The [http://www.haiku-os.org/development/coding-guidelines Coding Guidelines] are expected to be followed when submitting patches.
     7The [https://www.haiku-os.org/development/coding-guidelines Coding Guidelines] are expected to be followed when submitting patches.
    88
    99'''Note:''' When patching existing files that do not follow our Coding Guidelines, it is preferable to apply the stylization to the entire file. If that is not possible, then conform to the pervading style being used.
    10  * [http://dev.haiku-os.org/browser/haiku/trunk/src/tools/checkstyle checkstyle] can be used to help identify violations
     10 * [https://git.haiku-os.org/haiku/tree/src/tools/checkstyle checkstyle] can be used to help identify violations
    1111 * [wiki:CodingGuidelines/VIM] integrate with vim to check style.
     12 * [https://github.com/owenca/haiku-format.git haiku-format] can be used to check/correct the coding style of a file.
    1213
    1314Be aware, that these style checker tools may generate false positives (eg, evaluating comments as coding violations) or may miss other violations.
     
    2324=== Committing changes ===
    2425
    25  * Before making any commits to the Haiku repository (local even), be sure to [http://www.haiku-os.org/guides/building/get-source-git#configure_env configure the git environment] on your local system! Failure to configure git properly before a commit will result in incorrect naming in your commit and public humiliation on the mailing list.
    26  * Create patches from within the ''HAIKU_TOP'' directory. This is the directory that contains ''configure'' and typically is the ''haiku/'' or ''buildtools/'' branch.
    27         * {{{git status}}} will display which files are modified, added, or deleted. Use `git diff` to inspect your changes.
     26 * Before making any commits to the Haiku repository (local even), be sure to [https://www.haiku-os.org/guides/building/get-source-git#configure_env configure the git environment] on your local system! Failure to configure git properly before a commit will result in incorrect naming in your commit.
     27 * {{{git status}}} will display which files are modified, added, or deleted. Use `git diff`to inspect your changes.
    2828 * You'll then have to commit your changes locally by adding the changed or added files (`git add my-file my/new/file`), and then do a `git commit`.
    2929        * 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.
     
    3535Create an account on [https://review.haiku-os.org Haiku's Gerrit instance] using your GitHub account, and add your SSH keys.
    3636
    37 '''Note''': If, after creating an account, you do not have any email addresses attached, please create a ticket under the component {{{Website/Gerrit}}} and specify your GitHub username and the email address you would like the administrators to set for you.
    38 
    39 '''Note''': Any commits submitted to Gerrit ''must'' have the same email address as is in your Gerrit account, or else Gerrit will reject your submission!
     37'''Note''': Any commits submitted to Gerrit ''must'' have the same email address and user name as is in your Gerrit account, or else Gerrit will reject your submission!
    4038
    4139Then submit your commits to Gerrit like this:
     
    6563''Lastly and most importantly'': once a developer reviews your submitted code, expect them to point out any and all flaws. This is standard procedure and is constructive criticism. Remember, we want to help you improve your coding abilities.
    6664
    67 You may want to either subscribe to or read the [http://www.freelists.org/list/haiku-commits haiku-commits] mailing list archives. It is quite common for the discussion of recently committed code to occur on this list.
     65You may want to either subscribe to or read the [https://www.freelists.org/list/haiku-commits haiku-commits] mailing list archives. It happens that discussions of recently committed code occur on this list, even if normally the discussion is mainly on our Gerrit instance...