Skip to content

Commit

Permalink
Update naming conventions (#46)
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
rgreinho authored Jun 15, 2024
1 parent 33f48d1 commit 7829840
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 31 deletions.
4 changes: 2 additions & 2 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Disable some built-in rules.
no-duplicate-header:
allow_different_nesting: true
no-duplicate-heading:
siblings_only: true
line-length:
tables: false
code_blocks: false
Expand Down
19 changes: 9 additions & 10 deletions content/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,15 @@ the repository of the project you are working on.
- Commit messages should follow best practices, including explaining the context
of the problem and how it was solved, including in caveats or follow up
changes required. They should tell the story of the change and provide readers
understanding of what led to it. Please refer to [How to Write a Git Commit
Message] for more details.
- If your [pull request] is a work in progress, create it as a [draft pull
request].
- Any [pull request] inactive for 28 days will be automatically closed. If you
need more time to work on it, ask maintainers, to add the appropriate label to
it. Use the `@` mention in the comments.
- Unless explicitly asked, [pull request] which don't pass all the CI checks
will not be reviewed. Use the `@` mention in the comments to ask maintainers
to help you.
understanding of what led to it. Please refer to [How to Write a Git
Commit Message] for more details.
- If your [pull request] is a work in progress, create it as a [draft pull request].
- Any [pull request] inactive for 28 days will be automatically closed. If you need
more time to work on it, ask maintainers, to add the appropriate label to it. Use
the `@` mention in the comments.
- Unless explicitly asked, [pull request] which don't pass all the CI checks will
not be reviewed. Use the `@` mention in the comments to ask maintainers to help
you.

## Commit example

Expand Down
4 changes: 2 additions & 2 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ for the bike industry working to make bicycling safe, convenient, and fun for
people of all ages and abilities. The [Bicycle Network Analysis], a.k.a. the
BNA, is open source software that assesses the quality and connectivity of bike
networks in cities. The [BNA] is an integral part of PeopleForBikes’ [City
Ratings] program, which measures progress towards building great cities for
bikes, shares best practices, and engages more people in bike advocacy.
Ratings] program, which measures progress towards building great cities for bikes,
shares best practices, and engages more people in bike advocacy.

**BNA Mechanics** is the technical group developing the [BNA]. We aim to
simplify and automate tasks to help our advocates focus on what they do best:
Expand Down
6 changes: 4 additions & 2 deletions content/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,12 +255,14 @@ Add the new `font-faces` to `styles/globals.css`:

@font-face {
font-family: "Dharma Gothic E";
src: url("../public/fonts/Dharma Type - DharmaGothicE-ExBold.otf") format("opentype");
src: url("../public/fonts/Dharma Type - DharmaGothicE-ExBold.otf")
format("opentype");
}

@font-face {
font-family: "Dharma Gothic E";
src: url("../public/fonts/Dharma Type - DharmaGothicE-ExLight.otf") format("opentype");
src: url("../public/fonts/Dharma Type - DharmaGothicE-ExLight.otf")
format("opentype");
}
```

Expand Down
29 changes: 14 additions & 15 deletions content/standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,8 @@ type of work being done:

Default: [MIT]

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

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

### Versioning

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

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

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

- v21.17
- v22.4

#### Examples

- template-scorecard-v22.4.svg
- city_ratings_v22.7.csv
- template-scorecard-v22.05.4.svg
- city_ratings_v22.11.csv
- chicago_illinois-scorecard-v24.05.pdf
- chicago_illinois-scorecard-v24.05.3.pdf

### Visual assets

Expand Down

0 comments on commit 7829840

Please sign in to comment.