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
docs: restructure contributing guidelines for adding new db source or tool (#1239)
## Description
This PR is for re-structuring the `CONTRIBUTING.md` guide to separate
the documentation for adding new database sources and adding new tools.
The "Adding a New Database Source and Tool" section has been split into
two distinct, standalone sections.
Fixes#1158
---------
Signed-off-by: SaxenaAnushka102 <[email protected]>
Co-authored-by: Averi Kitsch <[email protected]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+24-15Lines changed: 24 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,33 +25,42 @@ This project follows
25
25
26
26
## Contribution process
27
27
28
-
### Code reviews
28
+
> [!NOTE]
29
+
> New contributions should always include both unit and integration tests.
30
+
29
31
30
32
All submissions, including submissions by project members, require review. We
31
33
use GitHub pull requests for this purpose. Consult
32
34
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
33
35
information on using pull requests.
34
36
35
-
Within 2-5 days, a reviewer will review your PR. They may approve it, or request
36
-
changes. When requesting changes, reviewers should self-assign the PR to ensure
37
+
### Code reviews
38
+
39
+
* Within 2-5 days, a reviewer will review your PR. They may approve it, or request
40
+
changes.
41
+
* When requesting changes, reviewers should self-assign the PR to ensure
37
42
they are aware of any updates.
38
-
If additional changes are needed, push additional commits to your PR branch -
39
-
this helps the reviewer know which parts of the PR have changed. Commits will be
43
+
* If additional changes are needed, push additional commits to your PR branch -
44
+
this helps the reviewer know which parts of the PR have changed.
45
+
* Commits will be
40
46
squashed when merged.
41
-
Please follow up with changes promptly. If a PR is awaiting changes by the
47
+
* Please follow up with changes promptly.
48
+
* If a PR is awaiting changes by the
42
49
author for more than 10 days, maintainers may mark that PR as Draft. PRs that
43
50
are inactive for more than 30 days may be closed.
44
51
45
-
###Adding a New Database Source and Tool
52
+
## Adding a New Database Source or Tool
46
53
47
54
We recommend creating an
48
55
[issue](https://github.com/googleapis/genai-toolbox/issues) before
49
56
implementation to ensure we can accept the contribution and no duplicated work.
50
57
If you have any questions, reach out on our
51
-
[Discord](https://discord.gg/Dmm69peqjh) to chat directly with the team. New
52
-
contributions should be added with both unit tests and integration tests.
58
+
[Discord](https://discord.gg/Dmm69peqjh) to chat directly with the team.
59
+
60
+
> [!NOTE]
61
+
> New tools can be added for [pre-existing data sources](https://github.com/googleapis/genai-toolbox/tree/main/internal/sources). However, any new database source should also include at least one new tool type.
0 commit comments