Skip to content

Commit 60e49e0

Browse files
author
Brylie Christopher Oxley
committed
Shorten headings; add captions
1 parent 2254457 commit 60e49e0

File tree

1 file changed

+10
-3
lines changed
  • content/contributing-code/javascript-guidelines

1 file changed

+10
-3
lines changed

content/contributing-code/javascript-guidelines/contents.lr

+10-3
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,23 @@ the Creative Commons open-source ecosystem.
2020
## Philosophy
2121
A few philosophical guidelines can stand in place of a thousand narrow rules.
2222

23-
### Stewardship - build for longevity and maturity
23+
### Stewardship
24+
25+
> Build for longevity and maturity.
26+
2427
Choose an existing framework and set of tools and use them to make what matters to you. Avoiding creating a bespoke framework when a current framework would get you further down the road.
2528

2629
When choosing tools and technologies, keep an eye towards mature projects and standards built to last many years. Find projects that extend existing standards and ways of working.
2730

28-
### Focus - choose the right level of abstraction
31+
### Focus
32+
33+
> Choose the right level of abstraction and best use of time.
2934
3035
When developing, it is easy to find ourselves in layers of technology that are not directly contributing to our goals. For example, spending inordinate time with build tool configurations or type definitions instead of building features and getting user feedback. Choose tools that get out of the way and transparently support your work, creating what matters.
3136

32-
### Maintainability - write clean and conventional code
37+
### Maintainability
38+
39+
> Write clean and conventional code.
3340
3441
Code is read more often than it is written. Code is written for humans, not machines. As such, we can do ourselves a favor by making our code as reader-friendly as possible. Follow [clean code guidelines](https://github.com/ryanmcdermott/clean-code-javascript) as well as established development patterns.
3542

0 commit comments

Comments
 (0)