Add development notes

pull/1566/head
Ellet 1 year ago
parent 70d0fd26f7
commit b513bf21b1
No known key found for this signature in database
GPG Key ID: C488CC70BBCEF0D1
  1. 2
      .github/PULL_REQUEST_TEMPLATE.md
  2. 2
      CONTRIBUTING.md
  3. 6
      doc/development_notes.md
  4. 0
      scripts/before_push.sh

@ -28,7 +28,7 @@
- [ ] I titled the PR using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0).
- [ ] I did not modify the `CHANGELOG.md` nor the plugin version in `pubspec.yaml` files.
- [ ] All existing and new tests are passing.
- [ ] I have run the commands in `./scripts/before-push.sh` and it all passed successfully
- [ ] I have run the commands in `./scripts/before_push.sh` and it all passed successfully
## Breaking Change

@ -39,7 +39,7 @@ to `pubspec_overrides.yaml` which will be ignored by `.gitignore` and will be us
9. Mention the new changes in the [CHANGELOG.md](../CHANGELOG.md) in the next block
10. Run the following script if possible
```
./scripts/before-push.sh
./scripts/before_push.sh
```
11. When you are done sending your pull request, run:
```

@ -1,3 +1,9 @@
# Development notes
- When updating the translations or localizations in the app, please take a look at the [Translation](./translation.md) page as it has important notes in order to work, if you also add a feature that adds new localizations then you need to the instructions of it in order for the translations to take effect
- Only update the `version.dart` and `CHANGELOG.md` at the root folder of the repo, then run the script:
```console
dart ./scripts/regenerate_versions.dart
```
You must mention the changes of the other packages in the repo in the root `CHANGELOG.md` only and the script will replace the `CHANGELOG.md` in the other packages with the root one, and change the version in `pubspec.yaml` with the one in `version.dart` in the root folder
Loading…
Cancel
Save