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: README.md
+20-15Lines changed: 20 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
### [What's new with Bot Framework](https://docs.microsoft.com/en-us/azure/bot-service/what-is-new?view=azure-bot-service-4.0)
4
4
5
-
This repository contains code for the Python version of the [Microsoft Bot Framework SDK](https://github.com/Microsoft/botframework-sdk), which is part of the Microsoft Bot Framework - a comprehensive framework for building enterprise-grade conversational AI experiences.
5
+
This repository contains code for the Python version of the [Microsoft Bot Framework SDK](https://github.com/Microsoft/botframework-sdk), which is part of the Microsoft Bot Framework - a comprehensive framework for building enterprise-grade conversational AI experiences.
6
6
7
7
This SDK enables developers to model conversation and build sophisticated bot applications using Python. SDKs for [JavaScript](https://github.com/Microsoft/botbuilder-js), [.NET](https://github.com/Microsoft/botbuilder-dotnet) and [Java (preview)](https://github.com/Microsoft/botbuilder-java) are also available.
8
8
@@ -40,13 +40,13 @@ To get started building bots using the SDK, see the [Azure Bot Service Documenta
40
40
41
41
The [Bot Framework Samples](https://github.com/microsoft/botbuilder-samples) includes a rich set of samples repository.
42
42
43
-
If you want to debug an issue, would like to [contribute](#contributing), or understand how the Bot Builder SDK works, instructions for building and testing the SDK are below.
43
+
If you want to debug an issue, would like to [contribute](#contributing-code), or understand how the Bot Builder SDK works, instructions for building and testing the SDK are below.
Python "Virtual Environments" allow Python packages to be installed in an isolated location for a particular application, rather than being installed globally, as such it is common practice to use them. Click [here](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) to learn more about creating _and activating_ Virtual Environments in Python.
49
+
Python "Virtual Environments" allow Python packages to be installed in an isolated location for a particular application, rather than being installed globally, as such it is common practice to use them. Click [here](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) to learn more about creating _and activating_ Virtual Environments in Python.
50
50
51
51
### Clone
52
52
Clone a copy of the repo:
@@ -60,12 +60,7 @@ cd botbuilder-python
60
60
61
61
### Using the SDK locally
62
62
63
-
You will need the following 3 packages installed in your environment:
To use a local copy of the SDK you can link to these packages with the pip -e option.
63
+
To use a local copy of the SDK you can link to these packages with the pip -e option.
69
64
70
65
```bash
71
66
pip install -e ./libraries/botbuilder-schema
@@ -108,12 +103,12 @@ plugins: cov-2.5.1
108
103
Below are the various channels that are available to you for obtaining support and providing feedback. Please pay carful attention to which channel should be used for which type of content. e.g. general "how do I..." questions should be asked on Stack Overflow, Twitter or Gitter, with GitHub issues being for feature requests and bug reports.
109
104
110
105
### Github issues
111
-
[Github issues](https://github.com/Microsoft/botbuilder-python/issues) should be used for bugs and feature requests.
106
+
[Github issues](https://github.com/Microsoft/botbuilder-python/issues) should be used for bugs and feature requests.
112
107
113
108
### Stack overflow
114
109
[Stack Overflow](https://stackoverflow.com/questions/tagged/botframework) is a great place for getting high-quality answers. Our support team, as well as many of our community members are already on Stack Overflow providing answers to 'how-to' questions.
115
110
116
-
### Azure Support
111
+
### Azure Support
117
112
If you issues relates to [Azure Bot Service](https://azure.microsoft.com/en-gb/services/bot-service/), you can take advantage of the available [Azure support options](https://azure.microsoft.com/en-us/support/options/).
118
113
119
114
### Twitter
@@ -125,15 +120,25 @@ The [Gitter Channel](https://gitter.im/Microsoft/BotBuilder) provides a place wh
125
120
## Contributing and our code of conduct
126
121
We welcome contributions and suggestions. Please see our [contributing guidelines](./contributing.md) for more information.
127
122
128
-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
123
+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
124
+
129
125
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
130
126
[opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
131
127
128
+
### Contributing Code
129
+
130
+
In order to create pull requests, submitted code must pass ```pylint``` and ```black``` checks. Run both tools on every file you've changed.
131
+
132
+
For more information and installation instructions, see:
133
+
134
+
*[black](https://pypi.org/project/black/)
135
+
*[pylint](https://pylint.org/)
136
+
132
137
## Reporting Security Issues
133
-
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC)
138
+
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC)
134
139
at [secure@microsoft.com](mailto:secure@microsoft.com). You should receive a response within 24 hours. If for some
135
-
reason you do not, please follow up via email to ensure we received your original message. Further information,
136
-
including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the
140
+
reason you do not, please follow up via email to ensure we received your original message. Further information,
141
+
including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the
0 commit comments