Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Contribution Guidelines
* Minor changes can be done directly by editing code on GitHub. GitHub automatically creates a temporary branch and
files a PR. This is only suitable for really small changes like: spelling fixes, variable name changes or error string
change etc. For larger commits, following steps are recommended.
change etc. For larger commits, the following steps are recommended.
* (Optional) If you want to discuss your implementation with the users of GoFr, use the GitHub discussions of this repo.
* Configure your editor to use goimports and golangci-lint on file changes. Any code which is not formatted using these
tools, will fail on the pipeline.
Expand All @@ -16,7 +16,7 @@
No PR should ever decrease the overall code coverage.
* Once your code changes are done along with the test cases, submit a PR to development branch. Please note that all PRs
are merged from feature branches to development first.
* PR should be raised only when development is complete and the code is ready for review. This approach helps reduce the number of open pull requests and facilitates a more efficient review process for the team.
* A PR should be raised only when development is complete and the code is ready for review. This approach helps reduce the number of open pull requests and facilitates a more efficient review process for the team.
* All PRs need to be reviewed by at least 2 GoFr developers. They might reach out to you for any clarification.
* Thank you for your contribution. :)

Expand Down
6 changes: 3 additions & 3 deletions pkg/gofr/datasource/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ New datasources should implement logging with the following levels:
- INFO: Logs successful connection establishment.
- WARN: Logs connection retrying

> Additional logs can be added to enhance debugging and improving user experience.
> Additional logs can be added to enhance debugging and improve user experience.

5. Tracing

GoFr supports tracing for all the datasources, for example for SQL it traces the request using https://github.com/XSAM/otelsql.
If any official package or any widely used package is not available we have to implement our own, but in scope of a different ISSUE.
If any official package or any widely used package is not available we have to implement our own, but in the scope of a different ISSUE.


All logs should include:
Expand All @@ -47,7 +47,7 @@ All logs should include:

## Implementing New Datasources

GoFr offers built-in support for popular datasources like SQL (MySQL, PostgreSQL, SQLite), Redis, and Pub/Sub (MQTT, Kafka, Google as backend). Including additional functionalities within the core GoFr binary would increase the application size unnecessarily.
GoFr offers built-in support for popular datasources like SQL (MySQL, PostgreSQL, SQLite), Redis, and Pub/Sub (MQTT, Kafka, Google as a backend). Including additional functionalities within the core GoFr binary would increase the application size unnecessarily.

Therefore, GoFr utilizes a pluggable approach for new datasources by separating implementation in the following way:

Expand Down