Skip to content

Commit 052fe12

Browse files
authored
Update readme (#7)
* Update README.md remove empty links for plugins and advanced methods * task: add CONTRIBUTING.md file * remove local files from commit
1 parent 941078d commit 052fe12

File tree

2 files changed

+37
-8
lines changed

2 files changed

+37
-8
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#Contributing
2+
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.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ We have the following [types]
220220
### Fundamentals
221221
We have 3 types of basic plugins that you can use as a foundation for modifying functionality
222222

223-
- [`Plugin`]()
223+
- `Plugin`
224224
The most trivial plugin interface that will act on any event payload going through the timeline.
225225
For example if you wanted to add something to the context object of any event payload as an enrichment.
226226
```swift
@@ -245,7 +245,7 @@ class SomePlugin: Plugin {
245245
}
246246
```
247247

248-
- [`EventPlugin`]()
248+
- `EventPlugin`
249249
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.
250250
For example if you only wanted to act on `track` & `identify` events
251251
```swift
@@ -271,7 +271,7 @@ class SomePlugin: EventPlugin {
271271
}
272272
```
273273

274-
- [`DestinationPlugin`]()
274+
- `DestinationPlugin`
275275
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,
276276
allowing you to modify/augment how events reach the particular destination.
277277
For example if you wanted to implement a device mode destination plugin for Amplitude
@@ -305,14 +305,14 @@ analytics.track("Amplitude Event")
305305
```
306306

307307
### Advanced concepts
308-
- [`update(settings:)`]()
308+
- `update(settings:)`
309309
Use this function to react to any settings updates. This will be implicitly called when settings are updated.
310310
- OS Lifecycle hooks
311311
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`
316316
## Contributing
317317

318318
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

0 commit comments

Comments
 (0)