diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09ee1ca927..580378bafe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,103 +1,46 @@ -# Contributing to VS Code +## Contributing Issues -Welcome, and thank you for your interest in contributing to VS Code! +### Before Submitting an Issue +First, please do a search in [open issues](https://github.com/Microsoft/sqlopsstudio/issues) to see if the issue or feature request has already been filed. Use this [query](https://github.com/Microsoft/sqlopsstudio/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) to search for the most popular feature requests. -There are many ways that you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved. +If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment. -## Asking Questions +👍 - upvote -Have a question? Rather than opening an issue, please ask away on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode) using the tag `vscode`. +👎 - downvote -The active community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help. +If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below. -## Providing Feedback +## Writing Good Bug Reports and Feature Requests -Your comments and feedback are welcome, and the development team is available via handful of different channels. +File a single issue per problem and feature request. -See the [Feedback Channels](https://github.com/Microsoft/vscode/wiki/Feedback-Channels) wiki page for details about how to share your thoughts. +* Do not enumerate multiple bugs or feature requests in the same issue. +* Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. -## Reporting Issues +The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. -Have you identified a reproducible problem in VS Code? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible. +Please include the following with each issue. -### Identify Where to Report +* Version of SQL Ops Studio -The VS Code project is distributed across multiple repositories. Try to file the issue against the correct repository. Check the list of [Related Projects](https://github.com/Microsoft/vscode/wiki/Related-Projects) if you aren't sure which repo is correct. +> **Tip:** You can easily create an issue using `Report Issues` from SQL Operations Studio Help menu. -Can you recreate the issue even after [disabling all extensions](https://code.visualstudio.com/docs/editor/extension-gallery#_disable-an-extension)? If you find the issue is caused by an extension you have installed, please file an issue on the extension's repo directly. +* Reproducible steps (1... 2... 3...) and what you expected versus what you actually saw. +* Images, animations, or a link to a video. +* A code snippet that demonstrates the issue or a link to a code repository we can easily pull down onto our machine to recreate the issue. -### Look For an Existing Issue +> **Note:** Because we need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient. -Before you create a new issue, please do a search in [open issues](https://github.com/Microsoft/vscode/issues) to see if the issue or feature request has already been filed. - -Be sure to scan through the [most popular](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) feature requests. - -If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment: - -* 👍 - upvote -* 👎 - downvote - - -If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below. - -### Writing Good Bug Reports and Feature Requests - -File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue. - -Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. - -The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. - -Please include the following with each issue: - -* Version of VS Code - -* List of extensions that you have installed. - * **Tip:** You can easily add the list of extensions by creating the issue using `Report Issues` from VS Code's Help menu - -* Reproducible steps (1... 2... 3...) that cause the issue - -* What you expected to see, versus what you actually saw - -* Images, animations, or a link to a video showing the issue occuring - -* A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally - - * **Note:** Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient. - -* Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools) - -### Final Checklist +* Errors in the Dev Tools Console (Help | Toggle Developer Tools) Please remember to do the following: -* [ ] Search the issue repository to ensure your report is a new issue +* Search the issue repository to see if there exists a duplicate. +* Simplify your scripts around the issue so we can better isolate the problem. -* [ ] Recreate the issue after disabling all extensions - -* [ ] Simplify your code around the issue to better isolate the problem - -Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information! - -### Follow Your Issue - -Once submitted, your report will go into the [issue tracking](https://github.com/Microsoft/vscode/wiki/Issue-Tracking) work flow. Be sure to understand what will happen next, so you know what to expect, and how to continue to assist throughout the process. - -## Automated Issue Management - -We use a bot to help us manage issues. This bot currently: - -* Automatically closes any issue marked `needs-more-info` if there has been no response in past 7 days. -* Automatically locks 45 days after they are closed. - -If you believe the bot got something wrong, please open a new issue and let us know. +Don't feel bad if we can't reproduce the issue and ask for more information! ## Contributing Fixes - -If you are interested in writing code to fix issues, -please see [How to Contribute](https://github.com/Microsoft/vscode/wiki/How-to-Contribute) in the wiki. - -# Thank You! - -Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute. - +If you are interested in fixing issues and contributing directly to the code base, +please see the document [How to Contribute](https://github.com/Microsoft/sqlopsstudio/wiki/How-to-Contribute). diff --git a/README.md b/README.md index 5ea45fe3c7..c92cb95bb1 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,56 @@ -# Visual Studio Code - Open Source +# SQL Operations Studio -[![Build Status](https://travis-ci.org/Microsoft/vscode.svg?branch=master)](https://travis-ci.org/Microsoft/vscode) -[![Build Status](https://ci.appveyor.com/api/projects/status/vuhlhg80tj3e2a0l/branch/master?svg=true)](https://ci.appveyor.com/project/VSCode/vscode) -[![Coverage Status](https://img.shields.io/coveralls/Microsoft/vscode/master.svg)](https://coveralls.io/github/Microsoft/vscode?branch=master) -[![Gitter](https://img.shields.io/badge/chat-on%20gitter-blue.svg)](https://gitter.im/Microsoft/vscode) +SQL Operations Studio is a data management tool that enables you to work with SQL Server, Azure SQL DB and SQL DW from Windows, macOS and Linux. -[VS Code](https://code.visualstudio.com) is a new type of tool that combines the simplicity of -a code editor with what developers need for their core edit-build-debug cycle. Code -provides comprehensive editing and debugging support, an extensibility model, and lightweight integration with existing tools. +**Download SQL Operations Studio January Public Preview** -VS Code is updated monthly with new features and bug fixes. You can download it for Windows, macOS, and Linux on [VS Code's website](https://code.visualstudio.com/Download). To get the latest releases every day, you can install the [Insiders version of VS Code](https://code.visualstudio.com/insiders). This builds from the master branch and is updated at least daily. +Platform | Link +-- | -- +Windows Setup Installer | https://go.microsoft.com/fwlink/?linkid=866480 +Windows ZIP | https://go.microsoft.com/fwlink/?linkid=866479 +macOS ZIP | https://go.microsoft.com/fwlink/?linkid=866481 +Linux TAR.GZ | https://go.microsoft.com/fwlink/?linkid=866482 +Linux DEB | https://go.microsoft.com/fwlink/?linkid=866484 +Linux RPM | https://go.microsoft.com/fwlink/?linkid=866483 -

- VS Code in action -

+Go to our [download page](https://aka.ms/sqlopsstudio) for more specific instructions. -The [`vscode`](https://github.com/microsoft/vscode) repository is where we do development and there are many ways you can participate in the project, for example: +Try out the latest insiders build from `master` at https://github.com/Microsoft/sqlopsstudio/releases. -* [Submit bugs and feature requests](https://github.com/microsoft/vscode/issues) and help us verify as they are checked in -* Review [source code changes](https://github.com/microsoft/vscode/pulls) -* Review the [documentation](https://github.com/microsoft/vscode-docs) and make pull requests for anything from typos to new content +**Feature Highlights** + +- Cross-Platform DB management for Windows, macOS and Linux with simple XCopy deployment +- SQL Server Connection Management with Connection Dialog, Server Groups, Azure Integration and Registered Servers +- Object Explorer supporting schema browsing and contextual command execution +- T-SQL Query Editor with advanced coding features such as autosuggestions, error diagnostics, tooltips, formatting and peek definition +- Query Results Viewer with advanced data grid supporting large result sets, export to JSON\CSV\Excel, query plan and charting +- Management Dashboard supporting customizable widgets with drill-through actionable insights +- Visual Data Editor that enables direct row insertion, update and deletion into tables +- Backup and Restore dialogs that enables advanced customization and remote filesystem browsing, configured tasks can be executed or scripted +- Task History window to view current task execution status, completion results with error messages and task T-SQL scripting +- Scripting support to generate CREATE, SELECT, ALTER and DROP statements for database objects +- Workspaces with full Git integration and Find In Files support to managing T-SQL script libraries +- Modern light-weight shell with theming, user settings, full screen support, integrated terminal and numerous other features + +Here's some of these features in action. + + ## Contributing - If you are interested in fixing issues and contributing directly to the code base, -please see the document [How to Contribute](https://github.com/Microsoft/vscode/wiki/How-to-Contribute), which covers the following: +please see the document [How to Contribute](https://github.com/Microsoft/sqlopsstudio/wiki/How-to-Contribute), which covers the following: -* [How to build and run from source](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run-from-source) -* [The development workflow, including debugging and running tests](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#development-workflow) -* [Coding Guidelines](https://github.com/Microsoft/vscode/wiki/Coding-Guidelines) -* [Submitting pull requests](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#pull-requests) -* [Contributing to translations](https://aka.ms/vscodeloc) +* [How to build and run from source](https://github.com/Microsoft/sqlopsstudio/wiki/How-to-Contribute#Build-and-Run-From-Source) +* [The development workflow, including debugging and running tests](https://github.com/Microsoft/sqlopsstudio/wiki/How-to-Contribute#development-workflow) +* [Submitting pull requests](https://github.com/Microsoft/sqlopsstudio/wiki/How-to-Contribute#pull-requests) -Please see also our [Code of Conduct](CODE_OF_CONDUCT.md). +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. -## Feedback - -* Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode). -* Request a new feature on [GitHub](CONTRIBUTING.md). -* Vote for [popular feature requests](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc). -* File a bug in [GitHub Issues](https://github.com/Microsoft/vscode/issues). -* [Tweet](https://twitter.com/code) us with other feedback. - -## Related Projects -Many of the core components and extensions to Code live in their own repositories on GitHub. For example, the [node debug adapter](https://github.com/microsoft/vscode-node-debug) and the [mono debug adapter](https://github.com/microsoft/vscode-mono-debug). - -For a complete list, please see the [Related Projects](https://github.com/Microsoft/vscode/wiki/Related-Projects) page on our wiki. +## Privacy Statement +The [Microsoft Enterprise and Developer Privacy Statement](https://privacy.microsoft.com/en-us/privacystatement) describes the privacy statement of this software. ## License Copyright (c) Microsoft Corporation. All rights reserved. -Licensed under the [MIT](LICENSE.txt) License. +Licensed under the [Source EULA](LICENSE.txt).