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
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -126,15 +126,15 @@ To enhance the adoption of community-contributed drivers, we decided to split th
126
126
4. Posting a backlink to an open-source repository would be a good idea here so people can provide feedback on it by posting issues.
127
127
5. Before creating PR for the main repository, please make sure it's tested with the standard Cube E2E testing suite. An example of an E2E testing suite can be found here: https://github.com/cube-js/cube/blob/master/packages/cubejs-testing/test/driver-postgres.test.ts
128
128
6. If you're creating PR for the main repo, please be prepared to become a maintainer for this driver and dedicate some time to it. There're no specific time requirements. As a rule of thumb, you should expect to spend time on a weekly basis.
129
-
7. Due to limited resources Core team will review and merge driver PRs based on popularity and development activity.
129
+
7. Due to limited resources Core team will review and merge driver PRs based on popularity and development activity. Preference is given to drivers that are used by a significant number of users.
130
130
131
131
### Implementing a Driver
132
132
133
133
1. Copy existing driver package structure and name it in `@cubejs-backend/<db-name>-driver` format.
134
134
`@cubejs-backend/mysql-driver` is a very good candidate for copying this structure.
135
135
2. Please do not copy *CHANGELOG.md*.
136
136
3. Name driver class and adjust package.json, README.md accordingly.
137
-
4. As a rule of thumb please use only Pure JS libraries as a dependencies where possible.
137
+
4. As a rule of thumb please use only pure JS libraries as a dependencies where possible.
138
138
It increases driver adoption rate a lot.
139
139
5. Typically, you need to implement only `query()` and `testConnection()` methods of driver.
140
140
The rest will be done by `BaseDriver` class.
@@ -145,10 +145,9 @@ The rest will be done by `BaseDriver` class.
145
145
146
146
### Implementing a JDBC Driver
147
147
148
-
If there's existing JDBC Driver in place for Database of interest you can just create `DbTypes` configuration inside
0 commit comments