Skip to content

Commit c054fdb

Browse files
committed
Update file names
1 parent 630b566 commit c054fdb

9 files changed

+15
-11
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
All notable changes to this project will be documented in this file.
22

3+
## 2019-01-04
4+
5+
- Renamed some pages to better reflect their content
6+
37
## 2017-11-08
48

59
- Add PyPI guide

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ browser support standards.
2626
- [Building your project's front-end](guides/build.md)
2727
- [Code review guide](guides/code-reviews.md)
2828
- [Documenting your work](guides/documentation.md)
29-
- [Creating CommonJS modules](guides/javascript-modules-commonjs.md)
29+
- [Creating CommonJS modules](guides/creating-commonjs-modules.md)
3030
- [Git and GitHub](guides/git.md)
31-
- [Authoring, testing, and publishing npm modules](guides/npm.md)
31+
- [Authoring, testing, and publishing npm modules](guides/authoring-npm-modules.md)
3232
- [Publishing Python packages to PyPI](guides/pypi.md)
3333
- [Screen reader differences](guides/screen-reader-differences.md)
34-
- [Front-end testing](guides/testing.md)
35-
- [Browser testing with Sauce Labs](guides/sauce-labs.md)
36-
- [Using npm modules in projects](guides/npm-usage.md)
34+
- [Front-end testing](guides/front-end-testing.md)
35+
- [Browser testing with Sauce Labs](guides/browser-testing-with-sauce-labs.md)
36+
- [Using npm modules in projects](guides/using-npm-modules-in-projects.md)
3737
- [Unit testing Django and Wagtail](guides/unittesting-django-wagtail.md)
3838

3939
## Tools

guides/npm.md renamed to guides/authoring-npm-modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Whenever possible, we should write JavaScript as small modules that can be published to [npm](https://www.npmjs.com/). This document includes guidelines for authoring and publishing these modules.
44

5-
*If you are looking for guidelines on using Node modules, see [npm-usage.md](npm-usage.md).*
5+
*If you are looking for guidelines on using Node modules, see [using-npm-modules-in-projects.md](using-npm-modules-in-projects.md).*
66

77
The [full list of CFPB published node modules](https://www.npmjs.com/~cfpb) is availble on npm.
88

guides/browser-support.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ browsers:
119119
We use a mix of [Sauce Labs](https://saucelabs.com/) and
120120
[localtunnel](https://localtunnel.github.io/www/) to manually test our site.
121121
Be sure to review both the
122-
[testing](https://github.com/cfpb/development/blob/master/guides/testing.md)
122+
[testing](https://github.com/cfpb/development/blob/master/guides/front-end-testing.md)
123123
and [accessibility](https://github.com/cfpb/development/blob/master/guides/accessibility.md)
124124
guides when reviewing sites locally.
125125

File renamed without changes.

guides/testing.md renamed to guides/front-end-testing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Extol the [testing pyramid](https://docs.google.com/presentation/d/1NFjgq5SbQ4cr
66

77
## Manual testing & browser support QA
88

9-
Refer to the [Sauce Labs Guide](sauce-labs.md) for instructions on using Sauce Labs to manually test your application in a range of browsers and virtual machines.
9+
Refer to the [Sauce Labs Guide](browser-testing-with-sauce-labs.md) for instructions on using Sauce Labs to manually test your application in a range of browsers and virtual machines.
1010

1111
## Unit tests
1212

1313
If your code has logic, it should have unit tests. As seen in the pyramid, unit tests should comprise the majority of your tests. Why? Unit tests can be executed quickly, they can be easily automated, they're maintainable and they promote good practices by requiring your code to be written in concise, modular chunks.
1414

15-
A unit test verifies that a single discrete piece of your codebase works as expected. That "piece" could be a JavaScript function, a CommonJS/AMD module or some other unit of functionality. It's vaguely defined but don't let that scare you. Start by choosing one of the test frameworks below and writing tests for individual JavaScript methods. There are many guides about writing [JavaScript](http://alistapart.com/article/writing-testable-javascript) [unit](http://www.smashingmagazine.com/2012/06/27/introduction-to-javascript-unit-testing/) [tests](http://www.htmlgoodies.com/beyond/javascript/testing-javascript-using-the-jasmine-framework.html) that serve as great introductions. At CFPB we like to separate our JavaScript into discrete [npm modules](https://github.com/cfpb/development/blob/master/guides/npm.md). This makes testing easier because each module includes self-contained tests.
15+
A unit test verifies that a single discrete piece of your codebase works as expected. That "piece" could be a JavaScript function, a CommonJS/AMD module or some other unit of functionality. It's vaguely defined but don't let that scare you. Start by choosing one of the test frameworks below and writing tests for individual JavaScript methods. There are many guides about writing [JavaScript](http://alistapart.com/article/writing-testable-javascript) [unit](http://www.smashingmagazine.com/2012/06/27/introduction-to-javascript-unit-testing/) [tests](http://www.htmlgoodies.com/beyond/javascript/testing-javascript-using-the-jasmine-framework.html) that serve as great introductions. At CFPB we like to separate our JavaScript into discrete [npm modules](https://github.com/cfpb/development/blob/master/guides/authoring-npm-modules.md). This makes testing easier because each module includes self-contained tests.
1616

1717
### Test frameworks
1818
- [Jest](https://jestjs.io) is a comprehensive testing framework for Node and browser JavaScript.

guides/npm-usage.md renamed to guides/using-npm-modules-in-projects.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document provides general guidelines for using [npm](https://www.npmjs.com/) with CFPB projects.
44

5-
*If you are looking for guidelines on publishing Node modules, see [npm.md](npm.md).*
5+
*If you are looking for guidelines on publishing Node modules, see [authoring-npm-modules.md](authoring-npm-modules.md).*
66

77
Show me the code! Do you prefer seeing how something works instead of
88
instructions? If so, check out this pull request to the Amortize module. Each

standards/javascript.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ exist.
4040

4141
This style guide assumes you're using a module system such as [CommonJS][1],
4242
[AMD][2], [ES6 Modules][3], or any other kind of module system. If you are
43-
using CommonJS, refer to the [CommonJS guide](javascript-modules-commonjs.md)
43+
using CommonJS, refer to the [CommonJS guide](creating-commonjs-modules.md)
4444
for structuring your modules. Modules systems provide individual scoping,
4545
avoid leaks to the `global` object, and improve code base organization by
4646
**automating dependency graph generation**, instead of having to resort to

0 commit comments

Comments
 (0)