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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-8Lines changed: 18 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -15,24 +15,34 @@
15
15
</div>
16
16
<br>
17
17
18
+
18
19
The following guide will walk you through contributing new sources or changes to existing sources
19
20
and their demo pipelines and contains a troubleshooting section. Please also read
20
21
[DISTRIBUTION.md](docs/DISTRIBUTION.md) to understand how our sources are distributed to the users.
21
-
Refer to [BUILDING-BLOCKS.md](docs/BUILDING-BLOCKS.md) to learn about the basic building blocks of a
22
-
dlt source.
23
22
24
-
What do you can do here:
23
+
## Before you start
24
+
* 🚀 We are happy to accept **bugfixes and improvements** to existing sources!
25
+
* 📣 **We accept new sources but only those that cannot be easily implemented** via `REST API`, `sql_database` or `filesystem` or with **vibe coding**.
26
+
- see issues for source requests!
27
+
- queues and brokers like google pub sub or rabbitMQ
28
+
- SAP/ERP/HEALTH
29
+
- HR platforms
30
+
- Graph QL
31
+
32
+
33
+
34
+
## What you can do here
25
35
26
36
- Contribute a change to an existing verified source or its demo pipeline: Go to the
27
-
["Walktrough: Fix, improve, customize, document an existing source"](#walktrough-fix-improve-customize-document-an-existing-pipeline)
37
+
["Walkthrough: Fix, improve, customize, document an existing source"](#Walkthrough-fix-improve-customize-document-an-existing-pipeline)
28
38
section.
29
39
- Contribute a new verified source: Go to the
30
-
["Walktrough: Create and contribute a new source"](#walktrough-create-and-contribute-a-new-source)
40
+
["Walkthrough: Create and contribute a new source"](#Walkthrough-create-and-contribute-a-new-source)
31
41
section.
32
42
- Join our slack to get support from us by following the
33
43
[invitation link](https://dlthub.com/community).
34
44
35
-
## Walktrough: Fix, improve, customize, document an existing pipeline
45
+
## Walkthrough: Fix, improve, customize, document an existing pipeline
36
46
37
47
In this section you will learn how to contribute changes to an existing pipeline.
38
48
@@ -50,7 +60,7 @@ In this section you will learn how to contribute changes to an existing pipeline
50
60
4. Run the linter and formatter to check for any problems: `make lint-code`.
51
61
3. Proceed to the pull request section to [create a pull request to the main repo](#making-a-pull-request-to-the-main-repo-from-fork).
52
62
53
-
## Walktrough: Create and contribute a new source
63
+
## Walkthrough: Create and contribute a new source
54
64
55
65
In this section you will learn how to contribute a new source including tests and a demo pipeline
56
66
for that source. It is helpful to also read through the above section to see all the steps that are
@@ -342,7 +352,7 @@ In essence **DLT_SECRETS_TOML** is just your `secrets.toml` file and will be use
342
352
343
353
344
354
### Sharing and obtaining source credentials, test accounts, destination access
345
-
Typically we created a common test account for your source [before you started coding](#walktrough-create-and-contribute-a-new-source). This is an ideal situation - we can reuse your tests directly and can merge your work quickly.
355
+
Typically we create a common test account for your source [before you started coding](#Walkthrough-create-and-contribute-a-new-source). This is an ideal situation - we can reuse your tests directly and can merge your work quickly.
346
356
347
357
If you contributed a source and created own credentials, test accounts or test datasets please
348
358
include them in the tests or share them with `dlt` team so we can configure the CI job. If
Copy file name to clipboardExpand all lines: README.md
+14-8Lines changed: 14 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -19,23 +19,29 @@ This repository contains verified dlt sources and demo pipelines for each source
19
19
20
20
## How to add a verified source to your dlt project
21
21
`dlt` offers an `init` command that will clone and inject any source with an example pipeline from this repository into your project, setup the credentials and python dependencies. Please follow the step by step instructions in our [docs](https://dlthub.com/docs/walkthroughs/add-a-verified-source).
22
+
23
+
### We encourage you to hack the code
24
+
Verified sources code is added to your project with the expectation that you will hack or customize code yourself - as you need it.
25
+
26
+
22
27
## How to contact us and get help
23
28
Join our slack by following the [invitation link](https://dlthub.com/community)
24
29
25
-
- If you have added a source and something does not work, post in the `technical-help` channel
26
-
- If you want to contribute sources, customization or a fix, post in the `dlt-contributors` channel
27
-
28
30
## Reporting a source bug
29
31
Follow this link: [bug report template](https://github.com/dlt-hub/verified-sources/issues/new?template=bug-report.md)
30
32
31
-
## Requesting a source implementation
32
-
Follow this link: [source request template](https://github.com/dlt-hub/verified-sources/issues/new?template=request-new-source.md)
33
-
34
33
## How to contribute
34
+
* 🚀 We are happy to accept **bugfixes and improvements** to existing sources!
35
+
* 📣 **We accept new sources but only those that cannot be easily implemented** via `REST API`, `sql_database` or `filesystem` or with **vibe coding**.
36
+
- see issues for source requests!
37
+
- queues and brokers like google pub sub or rabbitMQ
38
+
- SAP/ERP/HEALTH
39
+
- HR platforms
40
+
- Graph QL
41
+
* 📣 **Before starting, announce your PR** with [source request template](https://github.com/dlt-hub/verified-sources/issues/new?template=bug-report.md)
42
+
35
43
Find step by step instruction as well as troubleshooting help in [CONTRIBUTING.md](CONTRIBUTING.md).
36
44
37
-
## Building blocks
38
-
Find a list of the building blocks of dlt with links to our official documentation in [BUILDING-BLOCKS.md](docs/BUILDING-BLOCKS.md).
39
45
40
46
## Building with LLMs
41
47
See README [`ai`](ai/README.md) folder for details.
0 commit comments