Skip to content

Commit

Permalink
Update readme (#7)
Browse files Browse the repository at this point in the history
* Update README.md

remove empty links for plugins and advanced methods

* task: add CONTRIBUTING.md file

* remove local files from commit
  • Loading branch information
alanjcharles authored May 5, 2021
1 parent 941078d commit 052fe12
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 8 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#Contributing
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.


### Commit message convention

We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:

- `fix`: bug fixes, e.g. fix crash due to deprecated method.
- `feat`: new features, e.g. add new method to the module.
- `refactor`: code refactor, e.g. migrate from class components to hooks.
- `docs`: changes into documentation, e.g. add usage example for the module..
- `test`: adding or updating tests, eg add integration tests using detox.
- `chore`: tooling changes, e.g. change CI config.

Our pre-commit hooks verify that your commit message matches this format when committing.


### Sending a pull request

> **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).
When you're sending a pull request:

- Prefer small pull requests focused on one change.
- Verify that linters and tests are passing.
- Review the documentation to make sure it looks good.
- Follow the pull request template when opening a pull request.
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ We have the following [types]
### Fundamentals
We have 3 types of basic plugins that you can use as a foundation for modifying functionality

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

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

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

### Advanced concepts
- [`update(settings:)`]()
- `update(settings:)`
Use this function to react to any settings updates. This will be implicitly called when settings are updated.
- OS Lifecycle hooks
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.
[`iOSLifecycleEvents`]()
[`macOSLifecycleEvents`]()
[`watchOSLifecycleEvents`]()
[`LinuxLifecycleEvents`]()
`iOSLifecycleEvents`
`macOSLifecycleEvents`
`watchOSLifecycleEvents`
`LinuxLifecycleEvents`
## Contributing

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

0 comments on commit 052fe12

Please sign in to comment.