Skip to content

Commit

Permalink
+PR feedback
Browse files Browse the repository at this point in the history
Signed-off-by: Spencer Gilbert <[email protected]>
  • Loading branch information
spencergilbert committed Jun 14, 2023
1 parent a54862e commit bbc18b2
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,14 @@ Vector team member will find this document useful.

### New sources, sinks, and transforms

If you're thinking of contributing a new source, sink, or transform to Vector, thank you that's way cool! There's a few
steps you need to think about if you want to make sure we can merge your contribution. We're here to help you along with
these steps, but they are a blocker to getting a new integration released.
If you're thinking of contributing a new source, sink, or transform to Vector, thank you that's way cool! The answers to
the below questions are required for each newly proposed component and depending on the answers, we may elect to not
include the proposed component. If you're having trouble with any of the questions, we're available to help you.

Prior to beginning work on a new source or sink if a GitHub Issue does not already exist, please open one to discuss the
introduction of the new integration. Maintainers will review the proposal with the following checklist in mind, try and
consider them when sharing your proposal to reduce the amount of time it takes to review your proposal. This list is not
exhaustive, and may be updated over time.
**Prior to beginning work on a new source or sink if a GitHub Issue does not already exist, please open one to discuss
the introduction of the new integration.** Maintainers will review the proposal with the following checklist in mind,
try and consider them when sharing your proposal to reduce the amount of time it takes to review your proposal. This
list is not exhaustive, and may be updated over time.

- [ ] Can the proposed component’s functionality be replicated by an existing component, with a specific configuration?
(ex: Azure Event Hub as a `kafka` sink configuration)
Expand All @@ -81,9 +81,8 @@ organization backed integrations: `databend` sink, `axiom` sink)
standpoint, and what is the expected ongoing maintenance burden?
- [ ] How will this integration be tested and QA’d for any changes and fixes?
- [ ] Will we have access to an account with the service if the integration is not open source?
- [ ] Is this integration something that can wait for a future plugin system?

To merge a new source, sink, or transform, the pull request needs to:
To merge a new source, sink, or transform, the pull request is required to:

- [ ] Add tests, especially integration tests if your contribution connects to an external service.
- [ ] Add instrumentation so folks using your integration can get insight into how it's working and performing. You can
Expand Down

0 comments on commit bbc18b2

Please sign in to comment.