From 986c49b152dbf43dd59b02866490a8d56bc79334 Mon Sep 17 00:00:00 2001 From: oraqlle <41113853+oraqlle@users.noreply.github.com> Date: Sun, 23 Jul 2023 13:17:08 +1000 Subject: [PATCH 1/5] Added GitHub PR template. --- .github/PULL_REQUEST_TEMPLATE.md | 35 ++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..7b842e6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ +# Submit a pull request + +Thank you for submitting a pull request! To speed up the review process, please ensure that everything below +is true: + +1. You have followed the [contributing guidelines][1] +2. The repositories you have linked are owned by you or you have permission to link them. +3. The PRs title is followed by your name eg. "Added solutions for {YYYY} - {First} {Last}" + +Any questions should be directed to @MonashDeepNeuron/executives. + +> Note: Ensure to delete the instructions once you have finished your PR. + +--- + +Replace any "X" below with information about your pull request. + +## Details + + + +X + +## Linked + + + +- X + +[1]: https://github.com/MonashDeepNeuron/HPC-Training/blob/main/CONTRIBUTING.md From ac8bcc0fb691c55a4eb5ac6c33d9e2071d29ea72 Mon Sep 17 00:00:00 2001 From: oraqlle <41113853+oraqlle@users.noreply.github.com> Date: Sun, 23 Jul 2023 13:21:29 +1000 Subject: [PATCH 2/5] Fixed some instructions to be more appropriate for this repo. --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7b842e6..5ba45b0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,10 +4,10 @@ Thank you for submitting a pull request! To speed up the review process, please is true: 1. You have followed the [contributing guidelines][1] -2. The repositories you have linked are owned by you or you have permission to link them. -3. The PRs title is followed by your name eg. "Added solutions for {YYYY} - {First} {Last}" +2. You have added an appropriate title to the PR. +3. Requested a review from the HPC Training team. -Any questions should be directed to @MonashDeepNeuron/executives. +Any questions should be directed to @MonashDeepNeuron/hpc-training. > Note: Ensure to delete the instructions once you have finished your PR. From 0184f85ce6010a788ddcdbfb79f46972ed3415fa Mon Sep 17 00:00:00 2001 From: oraqlle <41113853+oraqlle@users.noreply.github.com> Date: Sun, 23 Jul 2023 13:23:56 +1000 Subject: [PATCH 3/5] Clarified the delete instructions. --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5ba45b0..f8e876c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,11 +6,10 @@ is true: 1. You have followed the [contributing guidelines][1] 2. You have added an appropriate title to the PR. 3. Requested a review from the HPC Training team. +4. Delete any Markdown comments, instructions or anything else outside the below divider section once you have finished your PR. Any questions should be directed to @MonashDeepNeuron/hpc-training. -> Note: Ensure to delete the instructions once you have finished your PR. - --- Replace any "X" below with information about your pull request. @@ -32,4 +31,6 @@ eg. - X +--- + [1]: https://github.com/MonashDeepNeuron/HPC-Training/blob/main/CONTRIBUTING.md From ef93ab89fb69af4a1e437d1ecc71434e1fcee104 Mon Sep 17 00:00:00 2001 From: oraqlle <41113853+oraqlle@users.noreply.github.com> Date: Sun, 23 Jul 2023 13:25:53 +1000 Subject: [PATCH 4/5] Added step to ensure merging into dev staging branch. --- .github/PULL_REQUEST_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f8e876c..0e83422 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,6 +7,7 @@ is true: 2. You have added an appropriate title to the PR. 3. Requested a review from the HPC Training team. 4. Delete any Markdown comments, instructions or anything else outside the below divider section once you have finished your PR. +5. Ensure that you are merging into the `dev` and not `main`. Any questions should be directed to @MonashDeepNeuron/hpc-training. From 765f935393c614cb701b3759529a2159dda0899a Mon Sep 17 00:00:00 2001 From: oraqlle <41113853+oraqlle@users.noreply.github.com> Date: Sun, 23 Jul 2023 16:12:52 +1000 Subject: [PATCH 5/5] Updated CONTRIBUTING doc --- CONTRIBUTING.md | 33 +++++---------------------------- 1 file changed, 5 insertions(+), 28 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9248a66..5fb7ecc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,11 +10,13 @@ Any and all contributions are always very much appreciated. However, to make sur ## Steps to Contribute -1. Fork the repository. +1. Fork or Clone? + - If you are a member of Monash DeepNeuron you can simply clone repository. + - If you are an external contributor (non-member of Monash DeepNeuron) create a fork of the repository 2. Create a new branch based on the `dev` branch (`git checkout -b dev`). If your contribution is a bug fix, you should name your branch `bugfix/xxx`; for a feature, it should be `feature/xxx` etc. Otherwise, just use your good - judgment. Consistent naming of branches is appreciated since it makes the + judgment. Alternatively you can use the name of the branch generated by GitHub if you create a branch from an issue (if you create a branch from an issue, make sure to change the source branch from `main` to `dev`). Consistent naming of branches is appreciated since it makes the output of `git branch` easier to understand with a single glance. 3. Do your modifications on that branch. 4. Make sure your modifications did not break anything by building and verifying the output using: @@ -50,7 +52,7 @@ Any and all contributions are always very much appreciated. However, to make sur 6. Push the changes to your fork (`git push origin `). 7. Open a pull request against the package's `dev` branch (not against `main`). -We will do my best to respond in a timely manner. I might discuss your patch and suggest some modifications, or I might amend your patch myself and ask you for feedback. +We will do our best to respond in a timely manner. I might discuss your patch and suggest some modifications, or I might amend your patch myself and ask you for feedback. You will always be given proper credit. ## Style guide @@ -67,28 +69,3 @@ For C content such as examples: - Do not leave trailing white spaces at the end of lines, and no more than a single newline at the end of a source file. - A definition blocks' initial brace should start on a newline, not trail off the declaration. - -For C++ content such as examples: - -- Indent using 4 spaces. -- Do not leave trailing white spaces at the end of lines, and no more than a - single newline at the end of a source file. -- A definition blocks' initial brace should start on a newline, not trail off the declaration. -- Prefer direct initialisation (`{}` over `=`) over assignment initialisation, especially for primitive types. -- Prefer brace-based initialisation for invoking a types constructor. -- Use spaces on either side of constructor arguments when using braces (eg. `int{ _ }`). -- Use `auto` as variable introducer and declare type explicitly in the brace initialiser or on right-hand-side of the assignment. -- Prefer trailing return types on functions over prefixed notation. -- Prefer to separate functions declarations (eg. `constexpr auto`), signature, constant and reference qualifiers (classes), `noexcept` specification and return type on separate lines if function declaration gets too long. Indent the constant and references qualifiers, `noexcept` specification and return type if they are on a newline. - -```cxx -constexpr auto -really_long_function_signature(that_takes lots_of_arguments, with_really long_names, for_types and_arguments) - noexcept( noexcept(long_noexcept_specification) && noexcept(with_multiple_conditions) ) - -> a_really_long_return_type, template_type> -{} -``` - -- Indent `requires` clauses and `requires` expressions. -- `#include` should be sorted in alphabetical order. -- Mostly use your own judgment and stick to the style of the existing and surrounding code.