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
{{ message }}
This repository was archived by the owner on Dec 4, 2023. It is now read-only.
# 
2
2
3
-
### [Click here to find out what's new](https://github.com/Microsoft/botframework/blob/master/whats-new.md#whats-new)
3
+
This repository contains code for the Java version (currently in preview) 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.
This SDK enables developers to model conversation and build sophisticated bot applications using JavaScript. SDKs for [.NET](https://github.com/Microsoft/botbuilder-dotnet), [Python](https://github.com/Microsoft/botbuilder-python) and [JavaScript](https://github.com/Microsoft/botbuilder-js) are also available.
11
6
12
-
This repository contains code for the Java version of the Microsoft Bot Framework SDK. The Bot Framework SDK v4 enable developers to model conversation and build sophisticated bot applications.
7
+
To get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0). If you are an existing user, then you can also [find out what's new with Bot Framework](https://docs.microsoft.com/en-us/azure/bot-service/what-is-new?view=azure-bot-service-4.0).
13
8
9
+
For more information jump to a section below.
14
10
15
-
This repo is part of the [Microsoft Bot Framework](https://github.com/microsoft/botframework) - a comprehensive framework for building enterprise-grade conversational AI experiences.
11
+
*[Build status](#build-status)
12
+
*[Getting started](#getting-started)
13
+
*[Getting support and providing feedback](#getting-support-and-providing-feedback)
14
+
*[Contributing and our code of conduct](#contributing-and-our-code-of-conduct)
To get started see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0) for the v4 SDK.
17
+
## Build Status
18
18
19
-
## Contributing
19
+
| Branch | Description | Build Status | Coverage Status |
This project welcomes contributions and suggestions. Most contributions require you to agree to a
22
-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
23
-
the rights to use your contribution. For details, visit https://cla.microsoft.com.
23
+
## Getting Started
24
+
To get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0).
24
25
25
-
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
26
-
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
27
-
provided by the bot. You will only need to do this once across all repos using our CLA.
26
+
The [Bot Framework Samples](https://github.com/microsoft/botbuilder-samples) includes a rich set of samples repository.
28
27
29
-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
30
-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
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.
This project uses linting rules to enforce code standardization. These rules are specified in the file [bot-checkstyle.xml](./etc/bot-checkstyle.xml) with [CheckStyle](https://checkstyle.org/) and are hooked to Maven's build cycle.
36
-
37
-
**INFO**: Since the CheckStyle and PMD plugins are hooked into the build cycle, this makes the build **fail** in cases where there are linting warnings in the project files. Errors will be in the file ./target/checkstyle-result.xml and ./target/pmd.xml.
38
-
39
-
CheckStyle is available in different flavours:
40
-
-[Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle)
41
-
-[IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea)
**INFO**: Be sure to configure your IDE to use the file [bot-checkstyle.xml](./etc/bot-checkstyle.xml) instead of the default rules.
46
-
47
-
## Build and IDE
45
+
Now at the command prompt type:
46
+
```bash
47
+
mvn clean install
48
+
```
48
49
50
+
### Build and test locally
49
51
Any IDE that can import and work with Maven projects should work. As a matter of practice we use the command line to perform Maven builds. If your IDE can be configured to defer build and run to Maven it should also work.
50
52
- Java
51
53
- We use the [Azul JDK 8](https://www.azul.com/downloads/azure-only/zulu/?version=java-8-lts&architecture=x86-64-bit&package=jdk) to build and test with. While not a requirement to develop the SDK with, it is recommended as this is what Azure is using for Java 1.8. If you do install this JDK, make sure your IDE is targeting that JVM, and your path (from command line) and JAVA_HOME point to that.
@@ -61,14 +63,55 @@ Any IDE that can import and work with Maven projects should work. As a matter o
61
63
- Recommended setup
62
64
- When importing the SDK for the first time, make sure "Auto import" is checked.
63
65
64
-
## Reporting Security Issues
66
+
### Linting rules
67
+
68
+
This project uses linting rules to enforce code standardization. These rules are specified in the file [bot-checkstyle.xml](./etc/bot-checkstyle.xml) with [CheckStyle](https://checkstyle.org/) and are hooked to Maven's build cycle.
69
+
70
+
**INFO**: Since the CheckStyle and PMD plugins are hooked into the build cycle, this makes the build **fail** in cases where there are linting warnings in the project files. Errors will be in the file ./target/checkstyle-result.xml and ./target/pmd.xml.
71
+
72
+
CheckStyle is available in different flavours:
73
+
-[Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle)
74
+
-[IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea)
**INFO**: Be sure to configure your IDE to use the file [bot-checkstyle.xml](./etc/bot-checkstyle.xml) instead of the default rules.
79
+
80
+
## Getting support and providing feedback
81
+
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.
82
+
83
+
### Github issues
84
+
[Github issues](https://github.com/Microsoft/botbuilder-python/issues) should be used for bugs and feature requests.
85
+
86
+
### Stack overflow
87
+
[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.
65
88
66
-
Security issues and bugs should be reported privately, via email, to the Microsoft Security
receive a response within 24 hours. If for some reason you do not, please follow up via
69
-
email to ensure we received your original message. Further information, including the
70
-
[MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in
71
-
the [Security TechCenter](https://technet.microsoft.com/en-us/security/default).
89
+
### Azure Support
90
+
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/).
91
+
92
+
### Twitter
93
+
We use the [@botframework](https://twitter.com/botframework) account on twitter for announcements and members from the development team watch for tweets for @botframework.
94
+
95
+
### Gitter Chat Room
96
+
The [Gitter Channel](https://gitter.im/Microsoft/BotBuilder) provides a place where the Community can get together and collaborate.
97
+
98
+
## Contributing and our code of conduct
99
+
We welcome contributions and suggestions. Please see our [contributing guidelines](./contributing.md) for more information.
100
+
101
+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
102
+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
0 commit comments