Skip to content

Commit e2eca68

Browse files
authored
Merge pull request creativecommons#619 from creativecommons/js-simplicity
Add section on Simplicity and river-delta metaphor
2 parents 67385c2 + c4c17e1 commit e2eca68

File tree

1 file changed

+13
-5
lines changed
  • content/contributing-code/javascript-guidelines

1 file changed

+13
-5
lines changed

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

+13-5
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,29 @@ title: JavaScript Guidelines
66
---
77
description:
88

9-
These JavaScript Guidelines (style guide) help the community to focus on the intent of the code and work together with a minimum of friction.
9+
These JavaScript Guidelines (style guide) help the community focus on the code's intent and work together with a minimum of friction.
1010
---
1111
body:
1212

1313
## Purpose
1414

15-
These JavaScript Guidelines help developers who are new to the community and want to make a contribution to the Creative Commons open-source ecosystem.
15+
These JavaScript Guidelines help developers who are new to the community and want to contribute to the Creative Commons open-source ecosystem.
1616

1717
## Philosophy
18-
A few philosophical guidelines can stand in place of a thousand narrow rules.
18+
A few philosophical guidelines can stand in place of a thousand narrow rules. These guidelines are not intended as absolute (black or white) truths but rather lenses to focus our vision when faced with subtle shades of ambiguity.
1919

20-
### Stewardship
20+
### Simplicity
21+
22+
> Use and build only what is _essential_ to a project.
23+
24+
Projects can quickly grow beyond their essence by taking on dependencies and features that are not central to their purpose. Keep the essential goal in mind as a project evolves. Take on only what is needed and only when the need arises.
25+
26+
### Stability
2127

2228
> Build for longevity and maturity.
2329
30+
It is easy to get swept away in the rushing waters of new projects, tools, and libraries. However, the sedimentary landscape left behind by the swift and meandering river of change can be unstable. It is certainly unwise to build one's home on a river delta.
31+
2432
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.
2533

2634
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.
@@ -39,7 +47,7 @@ Code is read more often than it is written. Code is written for humans, not mach
3947

4048
## Pragmatics
4149

42-
The following sections outline how we've put the philosophy into action. See the [creativecommons/chooser](https://github.com/creativecommons/chooser) project for an example of how we have applied the recommendations below.
50+
The following sections outline how we've put the philosophy into action. See the [creativecommons/chooser](https://github.com/creativecommons/chooser) project to exemplify how we have applied the recommendations below.
4351

4452
### Code formatting
4553

0 commit comments

Comments
 (0)