Skip to content

Commit d4c7380

Browse files
authored
docs: fix code blocks in CONTRIBUTING.md (#1162)
1 parent 50d6bcd commit d4c7380

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This project is opinionated and follows patterns and practices used by the team
88

99
## Understanding the Dart Frog repository
1010

11-
This is a mono repo, a repository that includes more than one individual project. In fact, the Dart Frog repository includes all the packages, example apps, CLIs, and IDE integration plugins that have a role in the Dart Frog developer experience.
11+
This is a mono repo, a repository that includes more than one individual project. In fact, the Dart Frog repository includes all the packages, example apps, CLIs, and IDE integration plugins that have a role in the Dart Frog developer experience.
1212

13-
The contents of the mono repo is divided into the following directories:
13+
The contents of the mono repo is divided into the following directories:
1414

1515
- [`tool/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/tool): contains internal operation scripts
1616
- [`assets/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/assets): images to embed into READMEs
@@ -20,7 +20,7 @@ The contents of the mono repo is divided into the following directories:
2020
- [`bricks/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/bricks): Internal mason bricks used by [dart_frog_cli][dart_frog_cli_link] to perform tasks such as creating new projects, starting a dev server, and building a prod server.
2121
- [`packages/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/packages): The source code of the packages that constitute the Dart Frog suite (`dart_frog_cli`, `dart_frog` and `dart_frog_gen`) as well as companion packages (such as `dart_frog_web_socket`).
2222

23-
Some of the included projects have more specific instructions on contribution. In these cases, the project root may include a `CONTRIBUTING.md` file with such instructions.
23+
Some of the included projects have more specific instructions on contribution. In these cases, the project root may include a `CONTRIBUTING.md` file with such instructions.
2424

2525
## Proposing a changes & reporting bugs
2626

@@ -62,46 +62,45 @@ Prerequisites:
6262

6363
### `dart_frog`
6464

65-
This is the user-facing package of the Dart Frog SDK, which means that Dart Frog users will be using its API to construct servers and runtime operations. It contains logic for request parsing, middleware, and response creation.
65+
This is the user-facing package of the Dart Frog SDK, which means that Dart Frog users will be using its API to construct servers and runtime operations. It contains logic for request parsing, middleware, and response creation.
6666

6767
### `dart_frog_gen`
6868

69-
This is the internal package used by the Dart Frog tooling to interpret the file disposition and from it construct a Dart Frog server.
69+
This is the internal package used by the Dart Frog tooling to interpret the file disposition and from it construct a Dart Frog server.
7070

7171
> :warning: **Warning**: this package is a dependency on the bricks bundled into the CLI. This means that any changes that break the bricks should be released with a major version, otherwise dart frog users may be blocked from performing tasks such as `dev`, `build`, and `new`.
7272
7373
### `dart_frog_cli`
7474

7575
A Dart command line interface package that serves as the main tool for Dart Frog. It includes bundled versions of the bricks under `bricks/`. To sync the source code of the bricks with new bundles, run `tool/generate_bundles.sh`.
7676

77-
7877
### Companion packages
7978

8079
The other items under `packages/` are companion packages in which dart_frog users may include on their project for specific server-side capabilities, such as auth (`dart_frog_auth`) and WebSockets (`dart_frog_web_socket`)
8180

82-
8381
## Releasing versions of packages
8482

8583
Before starting the release process of an individual package, first check:
8684

8785
1. If your local `main` branch is up to date:
86+
8887
```shell
8988
# ☁️ Ensure you're up to date with the GitHub remote
9089
git checkout main
9190
git fetch
9291
git status
93-
/```
92+
```
9493

9594
2. Ensure the [GitHub pipeline](https://github.com/VeryGoodOpenSource/dart_frog/actions) is green (has passed successfully) for your given package.
9695

9796
3. Run the script under `tool/release_ready.sh` within the package root repository and the desired new version.
9897

9998
```shell
10099
# 🚀 Run the release ready script (from packages/<package>)
101-
../../tool/release_ready.sh <version>
102-
/```
100+
../../tool/release_ready.sh <version>
101+
```
103102

104-
The above example will: update the version of <package> to <version>, update the dart_frog CHANGELOG.md, create and checkout to a local release branch.
103+
The above example will: update the version of `<package>` to `<version>`, update the dart_frog CHANGELOG.md, create and checkout to a local release branch.
105104

106105
4. Review the recently updated CHANGELOG file. You should manually amend the content were necessary. For example, by removing the redundant scope of some semantic pull requests or removing superfluous or unrelated logged changes.
107106

@@ -111,7 +110,6 @@ The above example will: update the version of <package> to <version>, update the
111110

112111
7. Open follow-up pull requests updating this package usage in any other Dart Frog package that depends on this new release.
113112

114-
115113
[conventional_commits_link]: https://www.conventionalcommits.org/en/v1.0.0
116114
[bug_report_link]: https://github.com/VeryGoodOpenSource/dart_frog/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=fix%3A+
117115
[issue_creation_link]: https://github.com/VeryGoodOpenSource/dart_frog/issues/new/choose
@@ -122,4 +120,4 @@ The above example will: update the version of <package> to <version>, update the
122120
[mason_install_link]: https://docs.brickhub.dev/installing/
123121
[dart_standalone_link]: https://dart.dev/get-dart
124122
[dart_on_flutter_link]: https://docs.flutter.dev/get-started/install
125-
[github_release_link]: https://github.com/VeryGoodOpenSource/dart_frog/releases
123+
[github_release_link]: https://github.com/VeryGoodOpenSource/dart_frog/releases

0 commit comments

Comments
 (0)