npm - newskit - Versions diffs - 5.4.3 → 5.4.4 - Mend

newskit 5.4.3 → 5.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (122) hide show

package/public/contributing/index.html CHANGED Viewed

@@ -6,7 +6,7 @@
             body {
               margin: 0;
             }
-            </style><script data-react-helmet="true" type="text/javascript">window._sp_ = {"config":{"accountId":259,"propertyHref":"https://newskit.co.uk","baseEndpoint":"https://cdn.privacy-mgmt.com"}}</script><script data-react-helmet="true" type="text/javascript" src="https://cdn.privacy-mgmt.com/messagingNoTcfApi.js" async=""></script><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="icon" type="image/x-icon" href="static/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="static/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="16x16" href="static/favicon-16x16.png"/><link rel="icon" type="image/png" sizes="32x32" href="static/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="192x192" href="static/android-chrome-192x192.png"/><link rel="manifest" href="static/site.webmanifest"/><meta name="msapplication-TileColor" content="#ffffff"/><meta name="msapplication-square150x150logo" content="mstile-150x150.png"/><meta name="theme-color" content="#ffffff"/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-5cd94c89d3acac5f.js"></script><script src="/_next/static/chunks/webpack-c0cad99bf97088e2.js" defer=""></script><script src="/_next/static/chunks/framework-a1dc26d0ae5e7407.js" defer=""></script><script src="/_next/static/chunks/main-ea11f884a96185e4.js" defer=""></script><script src="/_next/static/chunks/pages/_app-b9df849172598dfa.js" defer=""></script><script src="/_next/static/chunks/2ebec9a3-c51e9946115f3de3.js" defer=""></script><script src="/_next/static/chunks/2365afd3-2dcc650597ed5bea.js" defer=""></script><script src="/_next/static/chunks/61519-78f3aa2a16269f79.js" defer=""></script><script src="/_next/static/chunks/51863-2bfb71df42da8833.js" defer=""></script><script src="/_next/static/chunks/pages/contributing-3a8b8d68a424f173.js" defer=""></script><script src="/_next/static/4eEzQdZEpSITC7CcT92PH/_buildManifest.js" defer=""></script><script src="/_next/static/4eEzQdZEpSITC7CcT92PH/_ssgManifest.js" defer=""></script><script src="/_next/static/4eEzQdZEpSITC7CcT92PH/_middlewareManifest.js" defer=""></script></head><body><style data-emotion="css-global goexhq">html{scroll-behavior:smooth;scroll-padding-top:90px;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-regular-webfont.woff2') format('woff2'),url('static/fonts/dmsans-regular-webfont.woff') format('woff');font-style:normal;font-weight:400;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-italic-webfont.woff2') format('woff2'),url('static/fonts/dmsans-italic-webfont.woff') format('woff');font-style:italic;font-weight:400;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-medium-webfont.woff2') format('woff2'),url('static/fonts/dmsans-medium-webfont.woff') format('woff');font-style:normal;font-weight:500;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-mediumitalic-webfont.woff2') format('woff2'),url('static/fonts/dmsans-mediumitalic-webfont.woff') format('woff');font-style:italic;font-weight:500;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-bold-webfont.woff2') format('woff2'),url('static/fonts/dmsans-bold-webfont.woff') format('woff');font-style:normal;font-weight:700;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-bolditalic-webfont.woff2') format('woff2'),url('static/fonts/dmsans-bolditalic-webfont.woff') format('woff');font-style:italic;font-weight:700;font-display:swap;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-bold-webfont.woff2') format('woff2'),url('static/fonts/poppins-bold-webfont.woff') format('woff');font-weight:700;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-bolditalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-bolditalic-webfont.woff') format('woff');font-weight:normal;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-extrabold-webfont.woff2') format('woff2'),url('static/fonts/poppins-extrabold-webfont.woff') format('woff');font-weight:800;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-extrabolditalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-extrabolditalic-webfont.woff') format('woff');font-weight:800;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-italic-webfont.woff2') format('woff2'),url('static/fonts/poppins-italic-webfont.woff') format('woff');font-weight:400;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-light-webfont.woff2') format('woff2'),url('static/fonts/poppins-light-webfont.woff') format('woff');font-weight:300;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-lightitalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-lightitalic-webfont.woff') format('woff');font-weight:300;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-medium-webfont.woff2') format('woff2'),url('static/fonts/poppins-medium-webfont.woff') format('woff');font-weight:500;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-mediumitalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-mediumitalic-webfont.woff') format('woff');font-weight:500;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-regular-webfont.woff2') format('woff2'),url('static/fonts/poppins-regular-webfont.woff') format('woff');font-weight:400;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-semibold-webfont.woff2') format('woff2'),url('static/fonts/poppins-semibold-webfont.woff') format('woff');font-weight:600;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-semibolditalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-semibolditalic-webfont.woff') format('woff');font-weight:600;font-style:italic;}@font-face{font-family:'DM Mono';src:url('static/fonts/dmmono-medium.woff2') format('woff2'),url('static/fonts/dmmono-medium.woff') format('woff');font-style:normal;font-weight:500;font-display:swap;}</style><script type="text/javascript">(function(a,b,c,d){
+            </style><script data-react-helmet="true" type="text/javascript">window._sp_ = {"config":{"accountId":259,"propertyHref":"https://newskit.co.uk","baseEndpoint":"https://cdn.privacy-mgmt.com"}}</script><script data-react-helmet="true" type="text/javascript" src="https://cdn.privacy-mgmt.com/messagingNoTcfApi.js" async=""></script><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="icon" type="image/x-icon" href="static/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="static/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="16x16" href="static/favicon-16x16.png"/><link rel="icon" type="image/png" sizes="32x32" href="static/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="192x192" href="static/android-chrome-192x192.png"/><link rel="manifest" href="static/site.webmanifest"/><meta name="msapplication-TileColor" content="#ffffff"/><meta name="msapplication-square150x150logo" content="mstile-150x150.png"/><meta name="theme-color" content="#ffffff"/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-5cd94c89d3acac5f.js"></script><script src="/_next/static/chunks/webpack-c0cad99bf97088e2.js" defer=""></script><script src="/_next/static/chunks/framework-a1dc26d0ae5e7407.js" defer=""></script><script src="/_next/static/chunks/main-ea11f884a96185e4.js" defer=""></script><script src="/_next/static/chunks/pages/_app-b9df849172598dfa.js" defer=""></script><script src="/_next/static/chunks/2ebec9a3-c51e9946115f3de3.js" defer=""></script><script src="/_next/static/chunks/2365afd3-2dcc650597ed5bea.js" defer=""></script><script src="/_next/static/chunks/61519-78f3aa2a16269f79.js" defer=""></script><script src="/_next/static/chunks/51863-d9a28ce188f9fa84.js" defer=""></script><script src="/_next/static/chunks/pages/contributing-3a8b8d68a424f173.js" defer=""></script><script src="/_next/static/16aAekWqHChB9xZCUOXJs/_buildManifest.js" defer=""></script><script src="/_next/static/16aAekWqHChB9xZCUOXJs/_ssgManifest.js" defer=""></script><script src="/_next/static/16aAekWqHChB9xZCUOXJs/_middlewareManifest.js" defer=""></script></head><body><style data-emotion="css-global goexhq">html{scroll-behavior:smooth;scroll-padding-top:90px;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-regular-webfont.woff2') format('woff2'),url('static/fonts/dmsans-regular-webfont.woff') format('woff');font-style:normal;font-weight:400;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-italic-webfont.woff2') format('woff2'),url('static/fonts/dmsans-italic-webfont.woff') format('woff');font-style:italic;font-weight:400;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-medium-webfont.woff2') format('woff2'),url('static/fonts/dmsans-medium-webfont.woff') format('woff');font-style:normal;font-weight:500;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-mediumitalic-webfont.woff2') format('woff2'),url('static/fonts/dmsans-mediumitalic-webfont.woff') format('woff');font-style:italic;font-weight:500;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-bold-webfont.woff2') format('woff2'),url('static/fonts/dmsans-bold-webfont.woff') format('woff');font-style:normal;font-weight:700;font-display:swap;}@font-face{font-family:'DM Sans';src:url('static/fonts/dmsans-bolditalic-webfont.woff2') format('woff2'),url('static/fonts/dmsans-bolditalic-webfont.woff') format('woff');font-style:italic;font-weight:700;font-display:swap;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-bold-webfont.woff2') format('woff2'),url('static/fonts/poppins-bold-webfont.woff') format('woff');font-weight:700;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-bolditalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-bolditalic-webfont.woff') format('woff');font-weight:normal;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-extrabold-webfont.woff2') format('woff2'),url('static/fonts/poppins-extrabold-webfont.woff') format('woff');font-weight:800;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-extrabolditalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-extrabolditalic-webfont.woff') format('woff');font-weight:800;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-italic-webfont.woff2') format('woff2'),url('static/fonts/poppins-italic-webfont.woff') format('woff');font-weight:400;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-light-webfont.woff2') format('woff2'),url('static/fonts/poppins-light-webfont.woff') format('woff');font-weight:300;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-lightitalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-lightitalic-webfont.woff') format('woff');font-weight:300;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-medium-webfont.woff2') format('woff2'),url('static/fonts/poppins-medium-webfont.woff') format('woff');font-weight:500;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-mediumitalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-mediumitalic-webfont.woff') format('woff');font-weight:500;font-style:italic;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-regular-webfont.woff2') format('woff2'),url('static/fonts/poppins-regular-webfont.woff') format('woff');font-weight:400;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-semibold-webfont.woff2') format('woff2'),url('static/fonts/poppins-semibold-webfont.woff') format('woff');font-weight:600;font-style:normal;}@font-face{font-family:'Poppins';src:url('static/fonts/poppins-semibolditalic-webfont.woff2') format('woff2'),url('static/fonts/poppins-semibolditalic-webfont.woff') format('woff');font-weight:600;font-style:italic;}@font-face{font-family:'DM Mono';src:url('static/fonts/dmmono-medium.woff2') format('woff2'),url('static/fonts/dmmono-medium.woff') format('woff');font-style:normal;font-weight:500;font-display:swap;}</style><script type="text/javascript">(function(a,b,c,d){
               a='//tags.tiqcdn.com/utag/newsinternational/thetimes.newskit/dev/utag.js';
               b=document;
               c='script';
@@ -52,4 +52,4 @@
 </div></pre><pre><div class="css-0">feat(NUK-005): allow provided config object to extend other configs
 BREAKING CHANGE: `extends` key in config file is now used for extending other config files
-</div></pre><p color="inkBase" class="css-ysqpyd">We are following the specification for our commit message format, with the following exceptions:</p><p color="inkBase" class="css-ysqpyd">The <strong>type</strong> field MUST be one of the following (must be lower-case):</p><ul><li class="css-1w0w1ym">fix - a bug fix</li><li class="css-1w0w1ym">feat - a new feature</li><li class="css-1w0w1ym">chore - changes to the build process or auxiliary tools and libraries such as documentation generation</li><li class="css-1w0w1ym">docs - documentation only changes</li><li class="css-1w0w1ym">style - changes that do not affect the meaning of the code, e.g. white-space, formatting, missing semi-colons, etc</li><li class="css-1w0w1ym">refactor - a code change that neither fixes a bug nor adds a feature</li><li class="css-1w0w1ym">perf - a code change that improves performance</li><li class="css-1w0w1ym">test - adding or updating tests</li></ul><p color="inkBase" class="css-ysqpyd">The <strong>scope</strong> field MUST always be included, and is the (upper case) Jira ticket number for the task being completed (e.g. NUK-001). There MUST always be a Jira ticket for a task being completed, and this MUST be included as the scope. Do not insert a fake ticket number if you don&#x27;t have one - create a ticket instead!</p><p color="inkBase" class="css-ysqpyd">The <strong>description</strong> field SHOULD follow the tense of &quot;Applying this patch will <strong><strong>_</strong></strong>&quot;. Where the type is a verb, it can be considered to be included in the description. For example:</p><ul><li class="css-1w0w1ym">Good - fix(...): the array parsing issue when multiple spaces were contained in string</li><li class="css-1w0w1ym">Bad - fix(...): changed the multiple spaces parsing to get rid of the exception had a parsing issue</li><li class="css-1w0w1ym">Good - feat(...): add the ability to segment users in the MVT tool</li><li class="css-1w0w1ym">Bad - doc(...): deleted the reference to Chromebooks in the getting started guide</li></ul><p color="inkBase" class="css-ysqpyd">The desciption, body, and footer SHOULD be in lower case, except where acronyms, proper nouns, and references to filenames are used. Single sentences SHOULD NOT end in punctuation, but punctuation SHOULD be used for multiple sentences on a single line.</p><a id="rewriting-history" offset="0" class="css-1rlam1f"></a><h2 class="css-1j88enj">Rewriting History</h2><p color="inkBase" class="css-ysqpyd">SHOULD be avoided where possible, especially once a PR is open and being reviewed.</p><ul><li class="css-1w0w1ym"><p color="inkBase" class="css-ysqpyd">It makes it hard to reason about change in PRs.</p></li><li class="css-1w0w1ym"><p color="inkBase" class="css-ysqpyd">It also makes collaboration more difficult.</p></li><li class="css-1w0w1ym"><p color="inkBase" class="css-ysqpyd">It creates confusion when working with less technical users, pushing them to learn non standard workflows.</p></li></ul><a id="pull-requests" offset="0" class="css-1rlam1f"></a><h2 class="css-1j88enj">Pull Requests</h2><style data-emotion="css ft9m2c">.css-ft9m2c{font-family:"DM Sans",sans-serif;font-size:16px;line-height:1.5;font-weight:500;letter-spacing:0;color:#0A0A0A;margin-bottom:24px;margin-top:-50px;margin-bottom:8px;padding-top:70px;border-bottom:solid 1px #E4E4E4;padding-bottom:12px;}</style><h3 class="css-ft9m2c">Writing a pull request</h3><p color="inkBase" class="css-ysqpyd">PRs to be titled as per the RFC: <code class="css-os1kn4">&lt;type&gt;(&lt;scope&gt;): &lt;description&gt;</code> e.g. <code class="css-os1kn4">feat(NUK-001): Created the Login Screen UI</code></p><p color="inkBase" class="css-ysqpyd">We have a pull request template in our repo this SHOULD be filled out to the best of your ability to clearly indicate to the reviewer what has changed.</p><p color="inkBase" class="css-ysqpyd">The PR body SHOULD include a link to the corresponding JIRA ticket.</p><p color="inkBase" class="css-ysqpyd">For more information about best practices when writing your PR, please visit <a href="https://nidigitalsolutions.jira.com/wiki/spaces/NPP/pages/1319370846/Pull+Request" target="_blank" class="css-g09sk7"><span class="css-17x5lw"><span class="css-p4p8io">Pull Request</span></span></a> on our Confluence page.</p><h3 class="css-ft9m2c">Conducting a code review</h3><p color="inkBase" class="css-ysqpyd">Issues raised on a PR SHOULD only be marked as resolved by the person who raised them.</p><p color="inkBase" class="css-ysqpyd">Try to not to leave excess comments, if an issue is in lots of places call that out in a single message.</p><p color="inkBase" class="css-ysqpyd">Use a <!-- -->[:rocket]<!-- --> emoji to indicate to the reviewer that you’ve fixed an issue.</p><p color="inkBase" class="css-ysqpyd">Use suggestions more.</p><p color="inkBase" class="css-ysqpyd">Use Slack channel to notify that it’s ready for rereview.</p><h3 class="css-ft9m2c">Merging a PR</h3><p color="inkBase" class="css-ysqpyd">PR’s SHOULD be merged by the owner of that ticket/work. If you believe a PR is ready to merge, let the owner know so that they can merge it - the owner may know of a reason not to merge it at that time.</p><p color="inkBase" class="css-ysqpyd">PR owner SHOULD be responsible for bringing in latest develop changes into their branch unless ready for merge tag is present.</p><p color="inkBase" class="css-ysqpyd">PR owner SHOULD be responsible for running Aplitools changes unless ready for merge tag is present.</p><p color="inkBase" class="css-ysqpyd">Only the owner SHOULD close their PR, unless the PR is not inline with the specification outlined in this document.</p><h3 class="css-ft9m2c">Use labels to indicate state of PR</h3><p color="inkBase" class="css-ysqpyd">This will better allow the team to prioritise what to look at. <a href="https://github.com/newscorp-ghfb/newskit/labels" target="_blank" class="css-g09sk7"><span class="css-17x5lw"><span class="css-p4p8io">View here</span></span></a></p><a id="merging-to-develop" offset="0" class="css-1rlam1f"></a><h2 class="css-1j88enj">Merging to develop</h2><p color="inkBase" class="css-ysqpyd">SHOULD be squash merged to keep history on develop branch clean.</p><a id="merging-develop-to-main" offset="0" class="css-1rlam1f"></a><h2 class="css-1j88enj">Merging develop to main</h2><p color="inkBase" class="css-ysqpyd">Merge to main is done as a part of the release process, and SHOULD be a merge commit to preserve history.</p></div></div></div></div></main><style data-emotion="css 7cr3wq">.css-7cr3wq{background:#F4F4F4;padding-bottom:24px;}@media screen and (max-width: 767px){.css-7cr3wq{padding-top:40px;}}@media screen and (min-width: 768px){.css-7cr3wq{padding-top:48px;}}</style><footer class="css-7cr3wq"><div class="css-8atxkm"><style data-emotion="css 1l4gzx1">.css-1l4gzx1{box-sizing:border-box;-webkit-background-clip:padding-box;background-clip:padding-box;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-flex-wrap:wrap;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;}@media screen{.css-1l4gzx1{margin:-32px 8px 0 8px;}}@media screen and (min-width: 480px){.css-1l4gzx1{margin:-32px 8px 0 8px;}}@media screen and (min-width: 768px){.css-1l4gzx1{margin:-0px 8px 0 8px;}}@media screen and (min-width: 1024px){.css-1l4gzx1{margin:-0px 12px 0 12px;}}@media screen and (min-width: 1440px){.css-1l4gzx1{margin:-0px 12px 0 12px;}}</style><div class="css-1l4gzx1"><style data-emotion="css 1kimetj">.css-1kimetj{box-sizing:border-box;-webkit-background-clip:padding-box;background-clip:padding-box;-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;}@media screen{.css-1kimetj{padding:0 8px;margin-top:32px;-webkit-flex-basis:100%;-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%;}}@media screen and (min-width: 768px){.css-1kimetj{margin-top:0;}}@media screen and (min-width: 1024px){.css-1kimetj{padding:0 12px;}}</style><div class="css-1kimetj"><style data-emotion="css 1c02ias">.css-1c02ias{display:block;-webkit-box-pack:center;-ms-flex-pack:center;-webkit-justify-content:center;justify-content:center;margin-top:16px;}@media screen and (min-width: 768px){.css-1c02ias{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}}</style><div class="css-1c02ias"><style data-emotion="css 9yia0h">.css-9yia0h{text-align:center;display:block;}@media screen{.css-9yia0h{margin-bottom:40px;}.css-9yia0h:last-child{margin-bottom:0;}}@media screen and (min-width: 768px){.css-9yia0h{margin-right:48px;margin-bottom:24px;}.css-9yia0h:last-child{margin-bottom:24px;}}</style><span class="css-9yia0h"><style data-emotion="css 1m3x2du">.css-1m3x2du{display:inline-block;color:#3358CC;-webkit-text-decoration:none;text-decoration:none;}@media screen and (prefers-reduced-motion: no-preference){.css-1m3x2du{transition-property:color,fill;transition-duration:200ms,200ms;transition-timing-function:cubic-bezier(0, 0, .5, 1),cubic-bezier(0, 0, .5, 1);}}@media screen and (prefers-reduced-motion: reduce){.css-1m3x2du{transition-property:color,fill;transition-duration:0ms;transition-timing-function:cubic-bezier(0, 0, .5, 1),cubic-bezier(0, 0, .5, 1);}}.css-1m3x2du:hover:not(:disabled){color:#577FFB;-webkit-text-decoration:underline;text-decoration:underline;}.css-1m3x2du:active:not(:disabled){color:#AEBFFF;-webkit-text-decoration:none;text-decoration:none;}</style><a href="https://www.newscareers.co.uk/" target="_blank" class="css-1m3x2du"><span class="css-17x5lw"><style data-emotion="css 1ijiwz2">.css-1ijiwz2{margin:0;font-family:"Poppins",sans-serif;font-size:14px;line-height:21px;font-weight:600;letter-spacing:0;padding:0.5px 0px;display:inline-block;display:block;}.css-1ijiwz2::before{content:'';margin-bottom:-0.403em;display:block;}.css-1ijiwz2::after{content:'';margin-top:-0.4em;display:block;}</style><span class="css-1ijiwz2">Careers</span></span></a></span><span class="css-9yia0h"><a href="https://medium.com/newskit-design-system" target="_blank" class="css-1m3x2du"><span class="css-17x5lw"><span class="css-1ijiwz2">Blog</span></span></a></span><span class="css-9yia0h"><a href="#" role="button" class="css-1m3x2du"><span class="css-17x5lw"><span class="css-1ijiwz2">Privacy policy</span></span></a></span><span class="css-9yia0h"><a href="/help/terms-and-conditions/" class="css-1m3x2du"><span class="css-17x5lw"><span class="css-1ijiwz2">Terms &amp; conditions</span></span></a></span></div></div><div class="css-1kimetj"><style data-emotion="css 1a12fxg">.css-1a12fxg{border-style:solid;border-color:#E4E4E4;border-width:1px;border-width:0px;margin:0;border-top-width:1px;width:100%;}</style><hr data-testid="divider" aria-hidden="true" class="css-1a12fxg"/><style data-emotion="css 3dc54p">.css-3dc54p{margin:0;color:#535353;font-family:"DM Sans",sans-serif;font-size:12px;line-height:18px;font-weight:500;letter-spacing:0;padding:0.5px 0px;text-align:center;margin-top:24px;margin-bottom:40px;}.css-3dc54p svg{fill:#535353;}.css-3dc54p::before{content:'';margin-bottom:-0.391em;display:block;}.css-3dc54p::after{content:'';margin-top:-0.409em;display:block;}</style><div class="css-3dc54p">Copyright © <!-- -->2022<!-- --> News Corp UK &amp; Ireland Limited. All rights reserved. This website is published by News Corp UK &amp; Ireland Limited, 1 London Bridge Street, London, SE1 9GF. Registered in England No 81701. VAT number GB 243 8054 69.</div></div></div></div></footer></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"path":"/contributing/","pageProps":{}},"page":"/contributing","query":{},"buildId":"4eEzQdZEpSITC7CcT92PH","nextExport":true,"isFallback":false,"appGip":true,"scriptLoader":[]}</script></body></html>
+</div></pre><p color="inkBase" class="css-ysqpyd">We are following the specification for our commit message format, with the following exceptions:</p><p color="inkBase" class="css-ysqpyd">The <strong>type</strong> field MUST be one of the following (must be lower-case):</p><ul><li class="css-1w0w1ym">fix - a bug fix</li><li class="css-1w0w1ym">feat - a new feature</li><li class="css-1w0w1ym">chore - changes to the build process or auxiliary tools and libraries such as documentation generation</li><li class="css-1w0w1ym">docs - documentation only changes</li><li class="css-1w0w1ym">style - changes that do not affect the meaning of the code, e.g. white-space, formatting, missing semi-colons, etc</li><li class="css-1w0w1ym">refactor - a code change that neither fixes a bug nor adds a feature</li><li class="css-1w0w1ym">perf - a code change that improves performance</li><li class="css-1w0w1ym">test - adding or updating tests</li></ul><p color="inkBase" class="css-ysqpyd">The <strong>scope</strong> field MUST always be included, and is the (upper case) Jira ticket number for the task being completed (e.g. NUK-001). There MUST always be a Jira ticket for a task being completed, and this MUST be included as the scope. Do not insert a fake ticket number if you don&#x27;t have one - create a ticket instead!</p><p color="inkBase" class="css-ysqpyd">The <strong>description</strong> field SHOULD follow the tense of &quot;Applying this patch will <strong><strong>_</strong></strong>&quot;. Where the type is a verb, it can be considered to be included in the description. For example:</p><ul><li class="css-1w0w1ym">Good - fix(...): the array parsing issue when multiple spaces were contained in string</li><li class="css-1w0w1ym">Bad - fix(...): changed the multiple spaces parsing to get rid of the exception had a parsing issue</li><li class="css-1w0w1ym">Good - feat(...): add the ability to segment users in the MVT tool</li><li class="css-1w0w1ym">Bad - doc(...): deleted the reference to Chromebooks in the getting started guide</li></ul><p color="inkBase" class="css-ysqpyd">The desciption, body, and footer SHOULD be in lower case, except where acronyms, proper nouns, and references to filenames are used. Single sentences SHOULD NOT end in punctuation, but punctuation SHOULD be used for multiple sentences on a single line.</p><a id="rewriting-history" offset="0" class="css-1rlam1f"></a><h2 class="css-1j88enj">Rewriting History</h2><p color="inkBase" class="css-ysqpyd">SHOULD be avoided where possible, especially once a PR is open and being reviewed.</p><ul><li class="css-1w0w1ym"><p color="inkBase" class="css-ysqpyd">It makes it hard to reason about change in PRs.</p></li><li class="css-1w0w1ym"><p color="inkBase" class="css-ysqpyd">It also makes collaboration more difficult.</p></li><li class="css-1w0w1ym"><p color="inkBase" class="css-ysqpyd">It creates confusion when working with less technical users, pushing them to learn non standard workflows.</p></li></ul><a id="pull-requests" offset="0" class="css-1rlam1f"></a><h2 class="css-1j88enj">Pull Requests</h2><style data-emotion="css ft9m2c">.css-ft9m2c{font-family:"DM Sans",sans-serif;font-size:16px;line-height:1.5;font-weight:500;letter-spacing:0;color:#0A0A0A;margin-bottom:24px;margin-top:-50px;margin-bottom:8px;padding-top:70px;border-bottom:solid 1px #E4E4E4;padding-bottom:12px;}</style><h3 class="css-ft9m2c">Writing a pull request</h3><p color="inkBase" class="css-ysqpyd">PRs to be titled as per the RFC: <code class="css-os1kn4">&lt;type&gt;(&lt;scope&gt;): &lt;description&gt;</code> e.g. <code class="css-os1kn4">feat(NUK-001): Created the Login Screen UI</code></p><p color="inkBase" class="css-ysqpyd">We have a pull request template in our repo this SHOULD be filled out to the best of your ability to clearly indicate to the reviewer what has changed.</p><p color="inkBase" class="css-ysqpyd">The PR body SHOULD include a link to the corresponding JIRA ticket.</p><p color="inkBase" class="css-ysqpyd">For more information about best practices when writing your PR, please visit <a href="https://nidigitalsolutions.jira.com/wiki/spaces/NPP/pages/1319370846/Pull+Request" target="_blank" class="css-g09sk7"><span class="css-17x5lw"><span class="css-p4p8io">Pull Request</span></span></a> on our Confluence page.</p><h3 class="css-ft9m2c">Conducting a code review</h3><p color="inkBase" class="css-ysqpyd">Issues raised on a PR SHOULD only be marked as resolved by the person who raised them.</p><p color="inkBase" class="css-ysqpyd">Try to not to leave excess comments, if an issue is in lots of places call that out in a single message.</p><p color="inkBase" class="css-ysqpyd">Use a <!-- -->[:rocket]<!-- --> emoji to indicate to the reviewer that you’ve fixed an issue.</p><p color="inkBase" class="css-ysqpyd">Use suggestions more.</p><p color="inkBase" class="css-ysqpyd">Use Slack channel to notify that it’s ready for rereview.</p><h3 class="css-ft9m2c">Merging a PR</h3><p color="inkBase" class="css-ysqpyd">PR’s SHOULD be merged by the owner of that ticket/work. If you believe a PR is ready to merge, let the owner know so that they can merge it - the owner may know of a reason not to merge it at that time.</p><p color="inkBase" class="css-ysqpyd">PR owner SHOULD be responsible for bringing in latest develop changes into their branch unless ready for merge tag is present.</p><p color="inkBase" class="css-ysqpyd">PR owner SHOULD be responsible for running Aplitools changes unless ready for merge tag is present.</p><p color="inkBase" class="css-ysqpyd">Only the owner SHOULD close their PR, unless the PR is not inline with the specification outlined in this document.</p><h3 class="css-ft9m2c">Use labels to indicate state of PR</h3><p color="inkBase" class="css-ysqpyd">This will better allow the team to prioritise what to look at. <a href="https://github.com/newscorp-ghfb/newskit/labels" target="_blank" class="css-g09sk7"><span class="css-17x5lw"><span class="css-p4p8io">View here</span></span></a></p><a id="merging-to-develop" offset="0" class="css-1rlam1f"></a><h2 class="css-1j88enj">Merging to develop</h2><p color="inkBase" class="css-ysqpyd">SHOULD be squash merged to keep history on develop branch clean.</p><a id="merging-develop-to-main" offset="0" class="css-1rlam1f"></a><h2 class="css-1j88enj">Merging develop to main</h2><p color="inkBase" class="css-ysqpyd">Merge to main is done as a part of the release process, and SHOULD be a merge commit to preserve history.</p></div></div></div></div></main><style data-emotion="css 7cr3wq">.css-7cr3wq{background:#F4F4F4;padding-bottom:24px;}@media screen and (max-width: 767px){.css-7cr3wq{padding-top:40px;}}@media screen and (min-width: 768px){.css-7cr3wq{padding-top:48px;}}</style><footer class="css-7cr3wq"><div class="css-8atxkm"><style data-emotion="css 1l4gzx1">.css-1l4gzx1{box-sizing:border-box;-webkit-background-clip:padding-box;background-clip:padding-box;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-flex-wrap:wrap;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;}@media screen{.css-1l4gzx1{margin:-32px 8px 0 8px;}}@media screen and (min-width: 480px){.css-1l4gzx1{margin:-32px 8px 0 8px;}}@media screen and (min-width: 768px){.css-1l4gzx1{margin:-0px 8px 0 8px;}}@media screen and (min-width: 1024px){.css-1l4gzx1{margin:-0px 12px 0 12px;}}@media screen and (min-width: 1440px){.css-1l4gzx1{margin:-0px 12px 0 12px;}}</style><div class="css-1l4gzx1"><style data-emotion="css 1kimetj">.css-1kimetj{box-sizing:border-box;-webkit-background-clip:padding-box;background-clip:padding-box;-webkit-flex:1 0 auto;-ms-flex:1 0 auto;flex:1 0 auto;}@media screen{.css-1kimetj{padding:0 8px;margin-top:32px;-webkit-flex-basis:100%;-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%;}}@media screen and (min-width: 768px){.css-1kimetj{margin-top:0;}}@media screen and (min-width: 1024px){.css-1kimetj{padding:0 12px;}}</style><div class="css-1kimetj"><style data-emotion="css 1c02ias">.css-1c02ias{display:block;-webkit-box-pack:center;-ms-flex-pack:center;-webkit-justify-content:center;justify-content:center;margin-top:16px;}@media screen and (min-width: 768px){.css-1c02ias{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}}</style><div class="css-1c02ias"><style data-emotion="css 9yia0h">.css-9yia0h{text-align:center;display:block;}@media screen{.css-9yia0h{margin-bottom:40px;}.css-9yia0h:last-child{margin-bottom:0;}}@media screen and (min-width: 768px){.css-9yia0h{margin-right:48px;margin-bottom:24px;}.css-9yia0h:last-child{margin-bottom:24px;}}</style><span class="css-9yia0h"><style data-emotion="css 1m3x2du">.css-1m3x2du{display:inline-block;color:#3358CC;-webkit-text-decoration:none;text-decoration:none;}@media screen and (prefers-reduced-motion: no-preference){.css-1m3x2du{transition-property:color,fill;transition-duration:200ms,200ms;transition-timing-function:cubic-bezier(0, 0, .5, 1),cubic-bezier(0, 0, .5, 1);}}@media screen and (prefers-reduced-motion: reduce){.css-1m3x2du{transition-property:color,fill;transition-duration:0ms;transition-timing-function:cubic-bezier(0, 0, .5, 1),cubic-bezier(0, 0, .5, 1);}}.css-1m3x2du:hover:not(:disabled){color:#577FFB;-webkit-text-decoration:underline;text-decoration:underline;}.css-1m3x2du:active:not(:disabled){color:#AEBFFF;-webkit-text-decoration:none;text-decoration:none;}</style><a href="https://www.newscareers.co.uk/" target="_blank" class="css-1m3x2du"><span class="css-17x5lw"><style data-emotion="css 1ijiwz2">.css-1ijiwz2{margin:0;font-family:"Poppins",sans-serif;font-size:14px;line-height:21px;font-weight:600;letter-spacing:0;padding:0.5px 0px;display:inline-block;display:block;}.css-1ijiwz2::before{content:'';margin-bottom:-0.403em;display:block;}.css-1ijiwz2::after{content:'';margin-top:-0.4em;display:block;}</style><span class="css-1ijiwz2">Careers</span></span></a></span><span class="css-9yia0h"><a href="https://medium.com/newskit-design-system" target="_blank" class="css-1m3x2du"><span class="css-17x5lw"><span class="css-1ijiwz2">Blog</span></span></a></span><span class="css-9yia0h"><a href="#" role="button" class="css-1m3x2du"><span class="css-17x5lw"><span class="css-1ijiwz2">Privacy policy</span></span></a></span><span class="css-9yia0h"><a href="/help/terms-and-conditions/" class="css-1m3x2du"><span class="css-17x5lw"><span class="css-1ijiwz2">Terms &amp; conditions</span></span></a></span></div></div><div class="css-1kimetj"><style data-emotion="css 1a12fxg">.css-1a12fxg{border-style:solid;border-color:#E4E4E4;border-width:1px;border-width:0px;margin:0;border-top-width:1px;width:100%;}</style><hr data-testid="divider" aria-hidden="true" class="css-1a12fxg"/><style data-emotion="css 3dc54p">.css-3dc54p{margin:0;color:#535353;font-family:"DM Sans",sans-serif;font-size:12px;line-height:18px;font-weight:500;letter-spacing:0;padding:0.5px 0px;text-align:center;margin-top:24px;margin-bottom:40px;}.css-3dc54p svg{fill:#535353;}.css-3dc54p::before{content:'';margin-bottom:-0.391em;display:block;}.css-3dc54p::after{content:'';margin-top:-0.409em;display:block;}</style><div class="css-3dc54p">Copyright © <!-- -->2022<!-- --> News Corp UK &amp; Ireland Limited. All rights reserved. This website is published by News Corp UK &amp; Ireland Limited, 1 London Bridge Street, London, SE1 9GF. Registered in England No 81701. VAT number GB 243 8054 69.</div></div></div></div></footer></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"path":"/contributing/","pageProps":{}},"page":"/contributing","query":{},"buildId":"16aAekWqHChB9xZCUOXJs","nextExport":true,"isFallback":false,"appGip":true,"scriptLoader":[]}</script></body></html>