128. EPMO Open Source Coordination Office Redaction File Detail Report

Produced by Araxis Merge on 3/13/2018 7:47:01 PM Central Daylight Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.

128.1 Files compared

# Location File Last Modified
1 Wed Mar 14 00:47:01 2018 UTC
2 TASCore_v1.0_Build_2_Jan_2018.zip\Build_Artifacts\mccf-tas_TAS.01.00.121_20171213_164037.tar\assets\uswds CONTRIBUTING.md Wed Dec 13 23:09:45 2017 UTC

128.2 Comparison summary

Description Between
Files 1 and 2
Text Blocks Lines
Unchanged 0 0
Changed 0 0
Inserted 1 178
Removed 0 0

128.3 Comparison options

Whitespace
Character case Differences in character case are significant
Line endings Differences in line endings (CR and LF characters) are ignored
CR/LF characters Not shown in the comparison detail

128.4 Active regular expressions

No regular expressions were active.

128.5 Comparison detail

        1   ## Welcome !
        2  
        3   We’re so g lad you’re  thinking  about cont ributing t o an 18F o pen source  project!  If you’re  unsure abo ut anythin g, just as k — or sub mit your i ssue or pu ll request  anyway. T he worst t hat can ha ppen is we ’ll polite ly ask you  to change  something . We appre ciate all  friendly c ontributio ns.
        4  
        5   One of our  goals is  to ensure  a welcomin g environm ent for al l contribu tors to ou r projects . Our staf f follows  the [18F C ode of Con duct](http s://18f.gs a.gov/code -of-conduc t/), and a ll contrib utors shou ld do the  same.
        6  
        7   We encoura ge you to  read this  project’s  CONTRIBUTI NG policy  (you are h ere), its  [LICENSE]( https://gi thub.com/1 8F/web-des ign-standa rds/blob/d evelop/LIC ENSE.md),  [README](h ttps://git hub.com/18 F/web-desi gn-standar ds/blob/de velop/READ ME.md) and  its [Work flow](http s://github .com/18F/w eb-design- standards/ wiki/Workf low) proce ss.
        8  
        9   If you hav e any ques tions or w ant to rea d more, ch eck out th e [18F Ope n Source P olicy GitH ub reposit ory]( http s://github .com/18f/o pen-source -policy),  or just [s hoot us an  email](ma ilto:18f@g sa.gov).
        10  
        11   ## Guideli nes
        12  
        13   ### Contri butor Guid elines for  Design
        14  
        15   We have pr ovided som e guidelin es for fol ks that wo uld like t o submit n ew compone nts to the  U.S. Web  Design Sta ndards and  the lifec ycle those  new compo nents will  go throug h. For mor e detail,  please vis it the [gu idelines o n our wiki ](https:// github.com /18F/web-d esign-stan dards/wiki /Contribut ion-Guidel ines:-Desi gn).
        16  
        17   ### Submit ting an is sue
        18  
        19   To help us  get a bet ter unders tanding of  the issue  you’re su bmitting,  follow our  ISSUE TEM PLATE and  the guidel ines it de scribes.
        20  
        21   ### Submit ting a pul l request
        22  
        23   Here are a  few guide lines to f ollow when  submittin g a pull r equest:
        24  
        25   1. Create  a GitHub a ccount or  sign in to  your exis ting accou nt.
        26   1. Fork th is repo in to your Gi tHub accou nt (or jus t clone it  if you’re  an 18F te am member) . Read mor e about fo rking a re po here on  GitHub:
        27   [https://h elp.github .com/artic les/fork-a -repo/](ht tps://help .github.co m/articles /fork-a-re po/)
        28   1. Create  a branch f rom `devel op` that l ightly def ines what  you’re wor king on (f or example , add-styl es).
        29   1. Ensure  that your  contributi on works v ia `npm`,  if applica ble.
        30   1. Once yo u’re ready  to submit  a pull re quest, fil l out the  PULL REQUE ST templat e provided .
        31   1. Submit  your pull  request ag ainst the  `develop`  branch.
        32  
        33   [Open an i ssue](http s://github .com/18F/w eb-design- standards/ issues/new ) if you h ave questi ons or nee d help wit h setup.
        34  
        35   ### Runnin g locally
        36  
        37   The U.S. W eb Design  Standards  `uswds` pa ckage (the  zip downl oad and th e
        38   files need ed to use  the Standa rds on you r project)  is built  primarily  with
        39   two [Node. js] tools:  [Fractal]  and [Gulp ]. Once yo u've clone d this
        40   repository , you'll n eed to ins tall its d ependencie s:
        41  
        42   ```sh
        43   npm instal l
        44   ```
        45  
        46   **ProTip** : You can  also use [ Yarn], whi ch tends t o install  dependenci es more qu ickly than  npm.
        47  
        48   To start t he [Fracta l] live re load serve r, run:
        49  
        50   ```sh
        51   npm start
        52   ```
        53  
        54   Then, visi t [localho st:3000](h ttp://loca lhost:3000 ) in a web  browser t o
        55   peruse the  component  library.  While the  server is  running, a ny changes  that
        56   you make t o the comp onent temp lates or c onfigurati ons will r eload the  page
        57   automatica lly.
        58  
        59   If you're  working on  the JavaS cript or C SS, you ca n run the  "watch" ta sk in
        60   another sh ell to aut omatically  rebuild t he distrib ution file s that Fra ctal
        61   references  with:
        62  
        63   ```sh
        64   npm run wa tch
        65   ```
        66  
        67   ### Testin g
        68  
        69   To run the  component  unit test s, run:
        70  
        71   ```sh
        72   npm test
        73   ```
        74  
        75   This will  also run [ eslint] an d [styleli nt] to ens ure that t he JavaScr ipt
        76   and SCSS s ource file s meet our  coding st andards. T o lint wit hout the u nit
        77   tests, you 'll need [ Gulp][]. I nstall it  globally ( `npm insta ll -g
        78   gulp-cli`) , then run :
        79  
        80   ```sh
        81   gulp eslin t
        82   gulp style lint
        83   ```
        84  
        85   (Or, if yo u don't wa nt to inst all Gulp g lobally, y ou can run  `$(npm
        86   bin)/gulp`  instead o f `gulp`.)
        87  
        88   Note that  running th e tests al so require s an insta llation of
        89   Chrome v59  or higher  (v60 if y ou're on W indows).
        90  
        91   #### Visua l regressi on testing
        92  
        93   The Standa rds come w ith option al tooling  for detec ting visua l regressi ons,
        94   which can  be especia lly useful  if you're  refactori ng CSS.
        95  
        96   These test s work by  comparing  current sc reenshots  of the Sta ndards' Fr actal
        97   components  to "golde n" screens hots that  represent  what the c omponents  are
        98   supposed t o look lik e.
        99  
        100   Golden scr eenshots a re stored  on your lo cal develo pment syst em *only*;
        101   they're no t version  controlled .
        102  
        103   To generat e the gold en screens hots, run:
        104  
        105   ```
        106   node spec/ visual-reg ression-te ster.js te st --updat eGolden
        107   ```
        108  
        109   Then, make  any CSS r efactoring s (or swit ch to a br anch that  has them).
        110  
        111   To compare  the curre nt state o f your CSS  to the go lden scree nshots, ru n:
        112  
        113   ```
        114   node spec/ visual-reg ression-te ster.js te st
        115   ```
        116  
        117   If the cur rent scree nshots don 't match t heir golde n counterp arts, you  will
        118   be directe d to an HT ML file th at visuall y shows th e differen ces betwee n
        119   any confli cting scre enshots.
        120  
        121   ### Buildi ng
        122  
        123   To build t he `uswds`  package i n preparat ion for re leases, ru n:
        124  
        125   ```sh
        126   npm run bu ild:packag e
        127   # or
        128   gulp relea se
        129   ```
        130  
        131   ## Coding  guidelines
        132  
        133   The purpos e of our c oding styl eguides ar e to creat e consiste nt coding  practices  across 18F . The styl eguide sho uld be tre ated as a  guide — ru les can be  modified  according  to project  needs.
        134  
        135   This proje ct follows  the 18F F ront End G uide [CSS] (https://p ages.18f.g ov/fronten d/#css) an d [JavaScr ipt](https ://pages.1 8f.gov/fro ntend/#jav ascript).  Please use  this guid e for your  reference .
        136  
        137   ### Code c overage
        138  
        139   We use [co de coverag e](https:/ /en.wikipe dia.org/wi ki/Code_co verage) to ols to und erstand ho w much of  our JavaSc ript is te sted by ou r [unit te st suite]( spec/unit) . Code cov erage is o ne way (am ong many)  of measuri ng code _q uality_ mo re general ly. Here's  how it wo rks for co ntribution s:
        140  
        141   1. Each pu ll request  creates a  new cover age report  on [Code  Climate](h ttps://cod eclimate.c om/).
        142   1. Code Cl imate then  posts a s tatus mess age back t o GitHub t hat lists  the covera ge percent age on tha t branch,  and the di fference b etween tha t number a nd the one  last repo rted on ou r default  branch.
        143  
        144   For JavaSc ript contr ibutions,  we will re view the c ode covera ge percent age and ch ange to en sure that  the qualit y of our c ode is not  dramatica lly affect ed.
        145  
        146   High code  coverage n umbers are  generally  good, and  we would  prefer tha t our cove rage incre ases over  time. We w ill not ca tegoricall y reject c ontributio ns that re duce code  coverage,  but we may  ask contr ibutors to  refactor  their code , add new  unit tests , or modif y existing  tests to  avoid sign ificant re ductions i n coverage .
        147  
        148   ## Our use  of branch es
        149  
        150   See the [r elease doc umentation ](RELEASE. md#release -process)  for more i nformation  on our gi t/GitHub r elease wor kflow.
        151  
        152   ## License s and attr ibution
        153  
        154   ### A few  parts of t his projec t are not  in the pub lic domain
        155  
        156   For comple te attribu tion and l icensing i nformation  for parts  of the pr oject that  are not i n the publ ic domain,  see [LICE NSE.md](ht tps://gith ub.com/18F /web-desig n-standard s/blob/dev elop/LICEN SE.md).
        157  
        158   ### The re st of this  project i s in the p ublic doma in
        159  
        160   The rest o f this pro ject is in  the world wide [publ ic domain] (https://g ithub.com/ 18F/web-de sign-stand ards/blob/ develop/LI CENSE.md).
        161  
        162   This proje ct is in t he public  domain wit hin the Un ited State s, and
        163   copyright  and relate d rights i n the work  worldwide  are waive d through
        164   the [CC0 1 .0 Univers al public  domain ded ication](h ttps://cre ativecommo ns.org/pub licdomain/ zero/1.0/) .
        165  
        166   ### Contri butions wi ll be rele ased into  the public  domain
        167  
        168   All contri butions to  this proj ect will b e released  under the  CC0
        169   dedication . By submi tting a pu ll request , you are  agreeing t o comply
        170   with this  waiver of  copyright  interest.
        171  
        172  
        173   [Node.js]:  https://n odejs.org
        174   [Fractal]:  http://fr actal.buil d
        175   [Gulp]: ht tp://gulpj s.com/
        176   [Yarn]: ht tps://yarn pkg.com/
        177   [eslint]:  http://esl int.org/
        178   [stylelint ]: https:/ /stylelint .io/

Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.