Skip to content

Commit 7829840

Browse files
authored
Update naming conventions (#46)
Updates the naming conventions to match the latest outcome of the discussion of the BNA Working Group. Signed-off-by: Rémy Greinhofer <[email protected]>
1 parent 33f48d1 commit 7829840

File tree

5 files changed

+31
-31
lines changed

5 files changed

+31
-31
lines changed

.markdownlint.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disable some built-in rules.
2-
no-duplicate-header:
3-
allow_different_nesting: true
2+
no-duplicate-heading:
3+
siblings_only: true
44
line-length:
55
tables: false
66
code_blocks: false

content/CONTRIBUTING.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,15 @@ the repository of the project you are working on.
2727
- Commit messages should follow best practices, including explaining the context
2828
of the problem and how it was solved, including in caveats or follow up
2929
changes required. They should tell the story of the change and provide readers
30-
understanding of what led to it. Please refer to [How to Write a Git Commit
31-
Message] for more details.
32-
- If your [pull request] is a work in progress, create it as a [draft pull
33-
request].
34-
- Any [pull request] inactive for 28 days will be automatically closed. If you
35-
need more time to work on it, ask maintainers, to add the appropriate label to
36-
it. Use the `@` mention in the comments.
37-
- Unless explicitly asked, [pull request] which don't pass all the CI checks
38-
will not be reviewed. Use the `@` mention in the comments to ask maintainers
39-
to help you.
30+
understanding of what led to it. Please refer to [How to Write a Git
31+
Commit Message] for more details.
32+
- If your [pull request] is a work in progress, create it as a [draft pull request].
33+
- Any [pull request] inactive for 28 days will be automatically closed. If you need
34+
more time to work on it, ask maintainers, to add the appropriate label to it. Use
35+
the `@` mention in the comments.
36+
- Unless explicitly asked, [pull request] which don't pass all the CI checks will
37+
not be reviewed. Use the `@` mention in the comments to ask maintainers to help
38+
you.
4039

4140
## Commit example
4241

content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ for the bike industry working to make bicycling safe, convenient, and fun for
1010
people of all ages and abilities. The [Bicycle Network Analysis], a.k.a. the
1111
BNA, is open source software that assesses the quality and connectivity of bike
1212
networks in cities. The [BNA] is an integral part of PeopleForBikes’ [City
13-
Ratings] program, which measures progress towards building great cities for
14-
bikes, shares best practices, and engages more people in bike advocacy.
13+
Ratings] program, which measures progress towards building great cities for bikes,
14+
shares best practices, and engages more people in bike advocacy.
1515

1616
**BNA Mechanics** is the technical group developing the [BNA]. We aim to
1717
simplify and automate tasks to help our advocates focus on what they do best:

content/guidelines.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -255,12 +255,14 @@ Add the new `font-faces` to `styles/globals.css`:
255255

256256
@font-face {
257257
font-family: "Dharma Gothic E";
258-
src: url("../public/fonts/Dharma Type - DharmaGothicE-ExBold.otf") format("opentype");
258+
src: url("../public/fonts/Dharma Type - DharmaGothicE-ExBold.otf")
259+
format("opentype");
259260
}
260261

261262
@font-face {
262263
font-family: "Dharma Gothic E";
263-
src: url("../public/fonts/Dharma Type - DharmaGothicE-ExLight.otf") format("opentype");
264+
src: url("../public/fonts/Dharma Type - DharmaGothicE-ExLight.otf")
265+
format("opentype");
264266
}
265267
```
266268

content/standards.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,8 @@ type of work being done:
159159

160160
Default: [MIT]
161161

162-
For most substantial [BNA Mechanics] open source software projects, there's a
163-
simple default answer: [MIT].
162+
For most substantial [BNA Mechanics] open source software projects, there's a simple
163+
default answer: [MIT].
164164

165165
[MIT] is the
166166
[most popular license](https://github.com/blog/1964-open-source-license-usage-on-github-com)
@@ -272,24 +272,23 @@ the right license for those cases? Let's talk with [the team].
272272

273273
### Versioning
274274

275-
- Assets and should be versioned when applicable. For instance, it is common to
276-
go through several iterations for a `template`. In this case we follow the
277-
[calver] specification with the `vYY.Minor` scheme, where:
275+
- Assets should alway be versioned, following the [calver] specification with
276+
the `[v]YY.0M[.Minor]` scheme, where:
278277

279-
- The letter "v" (for "version") precedes the scheme
278+
- The letter "v" (for "version") precedes the scheme (optional).
280279
- `YY` represents the year with 2 digits (e.g.: 22 for 2022)
280+
- `0M` represents the zero-padded month of the year (e.g.: 01, 02, 11, 12)
281281
- `Minor` represents the iteration number starting at one (1), without
282-
zero-padding (e.g: 1, 2, 10, etc.)
282+
zero-padding (e.g: 1, 2, 10, etc.). It must be omitted when it is equal to
283+
zero (0).
283284

284-
- Examples:
285+
For instance, it is common to go through several iterations for a `template`,
286+
or several revisions of a document throughout the year:
285287

286-
- v21.17
287-
- v22.4
288-
289-
#### Examples
290-
291-
- template-scorecard-v22.4.svg
292-
- city_ratings_v22.7.csv
288+
- template-scorecard-v22.05.4.svg
289+
- city_ratings_v22.11.csv
290+
- chicago_illinois-scorecard-v24.05.pdf
291+
- chicago_illinois-scorecard-v24.05.3.pdf
293292

294293
### Visual assets
295294

0 commit comments

Comments
 (0)