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
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contribution Guidelines
2
2
3
-
Thank you for your interest in Dapr go SDK!
3
+
Thank you for your interest in Dapr Go SDK!
4
4
5
5
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.
6
6
@@ -12,7 +12,7 @@ This project has adopted the Microsoft Open Source Code of Conduct. For more inf
12
12
13
13
Contributions come in many forms: submitting issues, writing code, participating in discussions and community calls.
14
14
15
-
This document provides the guidelines for how to contribute to the Dapr go SDK project.
15
+
This document provides the guidelines for how to contribute to the Dapr Go SDK project.
16
16
17
17
## Issues
18
18
@@ -23,7 +23,7 @@ This section describes the guidelines for submitting issues
23
23
There are 4 types of issues:
24
24
25
25
- Issue/Bug: You've found a bug with the code, and want to report it, or create an issue to track the bug.
26
-
- Issue/Discussion: You have something on your mind, which requires input form others in a discussion, before it eventually manifests as a proposal.
26
+
- Issue/Discussion: You have something on your mind, which requires input from others in a discussion, before it eventually manifests as a proposal.
27
27
- Issue/Proposal: Used for items that propose a new idea or functionality. This allows feedback from others before code is written.
28
28
- Issue/Question: Use this issue type, if you need help or have a question.
29
29
@@ -37,12 +37,12 @@ Before you file an issue, make sure you've checked the following:
37
37
- 👍 up-vote
38
38
- 👎 down-vote
39
39
1. For proposals
40
-
- Some changes to the Dapr go SDK may require changes to the API. In that case, the best place to discuss the potential feature is the main [Dapr repo](https://github.com/dapr/dapr).
40
+
- Some changes to the Dapr Go SDK may require changes to the API. In that case, the best place to discuss the potential feature is the main [Dapr repo](https://github.com/dapr/dapr).
41
41
- Other examples could include bindings, state stores or entirely new components.
42
42
43
-
## Contributing to Dapr go SDK
43
+
## Contributing to Dapr Go SDK
44
44
45
-
This section describes the guidelines for contributing code/docs to Dapr go SDK.
45
+
This section describes the guidelines for contributing code/docs to Dapr Go SDK.
46
46
47
47
### Pull Requests
48
48
@@ -68,7 +68,7 @@ A good way to communicate before investing too much time is to create a "Work-in
68
68
### Use of Third-party code
69
69
70
70
- All third-party code must be placed in the `vendor/` folder.
71
-
-`vendor/` folder is managed by go modules which stores the source code of third-party go dependencies. - The `vendor/` folder should not be modified manually.
71
+
-`vendor/` folder is managed by Go modules which stores the source code of third-party Go dependencies. - The `vendor/` folder should not be modified manually.
72
72
- Third-party code must include licenses.
73
73
74
74
A non-exclusive list of code that must be places in `vendor/`:
Copy file name to clipboardExpand all lines: Readme.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Client library to help you build Dapr application in Go. This client supports al
7
7
## Usage
8
8
> Assuming you already have [installed](https://golang.org/doc/install) Go
9
9
10
-
Dapr Go client includes two packages: `client` (for invoking public Dapr APIs), and `service` (to create services that will be invoked by Dapr, this is sometimes refereed to as "callback").
10
+
Dapr Go client includes two packages: `client` (for invoking public Dapr APIs), and `service` (to create services that will be invoked by Dapr, this is sometimes referred to as "callback").
By default, Dapr relies on the network boundary to limit access to its API. If however the target Dapr API is configured with token-based authentication, users can configure the go Dapr client with that token in two ways:
220
+
By default, Dapr relies on the network boundary to limit access to its API. If however the target Dapr API is configured with token-based authentication, users can configure the Go Dapr client with that token in two ways:
221
221
222
222
##### Environment Variable
223
223
@@ -242,7 +242,7 @@ func main() {
242
242
243
243
In addition to the client capabilities that allow you to call into the Dapr API, the Go SDK also provides `service` package to help you bootstrap Dapr callback services in either gRPC or HTTP. Instructions on how to use it are located [here](./service/Readme.md)
244
244
245
-
## Contributing to Dapr go client
245
+
## Contributing to Dapr Go client
246
246
247
247
See the [Contribution Guide](./CONTRIBUTING.md) to get started with building and developing.
Copy file name to clipboardExpand all lines: example/Readme.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Dapr go client example
1
+
# Dapr Go client example
2
2
3
3
The `example` folder contains a Dapr enabled `serving` app and a `client` app that uses this SDK to invoke Dapr API for state and events, The `serving` app is available as HTTP or gRPC. The `client` app can target either one of these for service to service and binding invocations.
4
4
5
-
To run this example, start by first launching the service in ether HTTP or gRPC:
5
+
To run this example, start by first launching the service in either HTTP or gRPC:
Copy file name to clipboardExpand all lines: service/Readme.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# Dapr Service (Callback) SDK for Go
2
2
3
-
In addition to this Dapr API client, Dapr go SDK also provides `service` package to bootstrap your Dapr callback services. These services can be developed in either gRPC or HTTP:
3
+
In addition to this Dapr API client, Dapr Go SDK also provides `service` package to bootstrap your Dapr callback services. These services can be developed in either gRPC or HTTP:
4
4
5
5
*[HTTP Service](./http/Readme.md)
6
6
*[gRPC Service](./grpc/Readme.md)
7
7
8
8
## Templates
9
9
10
-
To accelerate your Dapr app development in go even further, we've craated a few GitHub templates which build on the above Dapr callback packages:
10
+
To accelerate your Dapr app development in Go even further, we've created a few GitHub templates which build on the above Dapr callback packages:
11
11
12
12
*[Dapr gRPC Service in Go](https://github.com/dapr-templates/dapr-grpc-service-template) - Template project to jump start your Dapr event subscriber service with gRPC development
13
13
*[Dapr HTTP Event Subscriber in Go](https://github.com/dapr-templates/dapr-http-event-subscriber-template) - Template project to jump start your Dapr event subscriber service with HTTP development
Copy file name to clipboardExpand all lines: service/grpc/Readme.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Dapr gRPC Service SDK for Go
2
2
3
-
Start by importing Dapr go`service/grpc` package:
3
+
Start by importing Dapr Go`service/grpc` package:
4
4
5
5
```go
6
6
daprd "github.com/dapr/go-sdk/service/grpc"
@@ -107,12 +107,12 @@ func runHandler(ctx context.Context, in *common.BindingEvent) (out []byte, err e
107
107
108
108
## Templates
109
109
110
-
To accelerate your gRPC Dapr app development in go even further you can use one of the GitHub templates integrating the gRPC Dapr callback package:
110
+
To accelerate your gRPC Dapr app development in Go even further you can use one of the GitHub templates integrating the gRPC Dapr callback package:
111
111
112
112
*[Dapr gRPC Service in Go](https://github.com/mchmarny/dapr-grpc-service-template) - Template project to jump start your Dapr event subscriber service with gRPC development
113
113
*[Dapr gRPC Event Subscriber in Go](https://github.com/mchmarny/dapr-grpc-event-subscriber-template) - Template project to jump start your Dapr event subscriber service with gRPC development
114
114
115
115
116
-
## Contributing to Dapr go client
116
+
## Contributing to Dapr Go client
117
117
118
118
See the [Contribution Guide](../../CONTRIBUTING.md) to get started with building and developing.
Copy file name to clipboardExpand all lines: service/http/Readme.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Dapr HTTP Service SDK for Go
2
2
3
-
Start by importing Dapr go`service/http` package:
3
+
Start by importing Dapr Go`service/http` package:
4
4
5
5
```go
6
6
daprd "github.com/dapr/go-sdk/service/http"
@@ -103,12 +103,12 @@ func runHandler(ctx context.Context, in *common.BindingEvent) (out []byte, err e
103
103
104
104
## Templates
105
105
106
-
To accelerate your HTTP Dapr app development in go even further you can use one of the GitHub templates integrating the HTTP Dapr callback package:
106
+
To accelerate your HTTP Dapr app development in Go even further you can use one of the GitHub templates integrating the HTTP Dapr callback package:
107
107
108
108
*[Dapr HTTP Event Subscriber in Go](https://github.com/mchmarny/dapr-http-event-subscriber-template) - Template project to jump start your Dapr event subscriber service with HTTP development
109
109
*[Dapr HTTP cron Handler in Go](https://github.com/mchmarny/dapr-http-cron-handler-template) - Template project to jump start your Dapr service development for scheduled workloads
110
110
111
111
112
-
## Contributing to Dapr go client
112
+
## Contributing to Dapr Go client
113
113
114
114
See the [Contribution Guide](../../CONTRIBUTING.md) to get started with building and developing.
0 commit comments