Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reminder to add changelog entry to pull request template #88

Merged
merged 2 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
### Description

### Checklist

- [ ] I added an entry to `CHANGELOG.md` if knowledge of this change could be valuable to users.
- [ ] I linked any relevant issues from https://github.com/maplibre/maplibre-navigation-ios/issues
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, maybe it would be worth while to also add a checkbox if the PR does not contain relevant changes? So contributors could select either one?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure it's worth adding another checkbox to the checklist - the existing text covers this if they read carefully.

I'm kind of struggling to improve upon what I already have. But if you want to re-write the text for both of these options, I wouldn't mind using it.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good, I think the current version is fine as well :)


Copy link
Collaborator Author

@michaelkirk michaelkirk Jul 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is what was meant by the previous "Open Tasks" heading, but feel free to correct me if I'm wrong here. I wasn't really sure what it meant. Or we can just get rid of it.

### Open Tasks
### Description

- [ ]

### Infos for Reviewer

6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- To simulate a route, pass a `SimulatedLocationManager` to `startNavigation()` function:

```swift
#if targetEnvironment(simulator)
#if targetEnvironment(simulator)
let locationManager = SimulatedLocationManager(route: route)
locationManager.speedMultiplier = 2
self.startNavigation(with: route, animated: false, locationManager: locationManager)
Expand All @@ -19,6 +19,10 @@
* Merged in <https://github.com/maplibre/maplibre-navigation-ios/pull/72>
* Updated "turf" geometry library from 0.2.2 to 2.8.0
* Merged in https://github.com/maplibre/maplibre-navigation-ios/pull/91
* Only require background audio when using speech synthesis in https://github.com/maplibre/maplibre-navigation-ios/pull/64
* Fix: Respond to changes in dynamic type without having to restart the app in https://github.com/maplibre/maplibre-navigation-ios/pull/65
* Fix: crash in EndOfRouteViewController and restore its presentation by in https://github.com/maplibre/maplibre-navigation-ios/pull/71
* Fix: retain cycles in RouteMapViewController

## 3.0.0 (Jun 15, 2024)
* The `speak` method in `RouteVoiceController` can be used without a given `RouteProgress` or the `RouteProgress` can explicitly ignored so that it will not be added to the voice instruction.
Expand Down
Loading