You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.
3
+
4
+
5
+
### Commit message convention
6
+
7
+
We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
8
+
9
+
-`fix`: bug fixes, e.g. fix crash due to deprecated method.
10
+
-`feat`: new features, e.g. add new method to the module.
11
+
-`refactor`: code refactor, e.g. migrate from class components to hooks.
12
+
-`docs`: changes into documentation, e.g. add usage example for the module..
13
+
-`test`: adding or updating tests, eg add integration tests using detox.
14
+
-`chore`: tooling changes, e.g. change CI config.
15
+
16
+
Our pre-commit hooks verify that your commit message matches this format when committing.
17
+
18
+
19
+
### Sending a pull request
20
+
21
+
> **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
22
+
23
+
When you're sending a pull request:
24
+
25
+
- Prefer small pull requests focused on one change.
26
+
- Verify that linters and tests are passing.
27
+
- Review the documentation to make sure it looks good.
28
+
- Follow the pull request template when opening a pull request.
29
+
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -220,7 +220,7 @@ We have the following [types]
220
220
### Fundamentals
221
221
We have 3 types of basic plugins that you can use as a foundation for modifying functionality
222
222
223
-
-[`Plugin`]()
223
+
-`Plugin`
224
224
The most trivial plugin interface that will act on any event payload going through the timeline.
225
225
For example if you wanted to add something to the context object of any event payload as an enrichment.
226
226
```swift
@@ -245,7 +245,7 @@ class SomePlugin: Plugin {
245
245
}
246
246
```
247
247
248
-
-[`EventPlugin`]()
248
+
-`EventPlugin`
249
249
A plugin interface that will act only on specific event types. You can choose the event types by only overriding the event functions you want.
250
250
For example if you only wanted to act on `track` & `identify` events
251
251
```swift
@@ -271,7 +271,7 @@ class SomePlugin: EventPlugin {
271
271
}
272
272
```
273
273
274
-
-[`DestinationPlugin`]()
274
+
-`DestinationPlugin`
275
275
A plugin interface most commonly used for device-mode destinations. This plugin contains an internal timeline that follows the same process as the analytics timeline,
276
276
allowing you to modify/augment how events reach the particular destination.
277
277
For example if you wanted to implement a device mode destination plugin for Amplitude
Use this function to react to any settings updates. This will be implicitly called when settings are updated.
310
310
- OS Lifecycle hooks
311
311
Plugins can also hook into lifecycle events by conforming to the platform appropriate protocol. These functions will get called implicitly as the lifecycle events are processed.
312
-
[`iOSLifecycleEvents`]()
313
-
[`macOSLifecycleEvents`]()
314
-
[`watchOSLifecycleEvents`]()
315
-
[`LinuxLifecycleEvents`]()
312
+
`iOSLifecycleEvents`
313
+
`macOSLifecycleEvents`
314
+
`watchOSLifecycleEvents`
315
+
`LinuxLifecycleEvents`
316
316
## Contributing
317
317
318
318
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
0 commit comments