diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c62f265d..b68f4c4d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85d81a00..029923e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: ``` diff --git a/doc/development_notes.md b/doc/development_notes.md index 25633cda..23d60db8 100644 --- a/doc/development_notes.md +++ b/doc/development_notes.md @@ -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 \ No newline at end of file diff --git a/scripts/before-push.sh b/scripts/before_push.sh similarity index 100% rename from scripts/before-push.sh rename to scripts/before_push.sh