Skip to content

Commit 66570bf

Browse files
authored
Update READMEs for initial public release (#1)
Adds compliant notices for privacy, data collection, security, support and licenses.
1 parent 271faee commit 66570bf

File tree

3 files changed

+50
-28
lines changed

3 files changed

+50
-28
lines changed

PRIVACY

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Data Collection. The software may collect information about you and your use of
2+
the software and send it to Microsoft. Microsoft may use this information to
3+
provide services and improve our products and services. You may turn off the
4+
telemetry as described in the repository. There are also some features in the
5+
software that may enable you and Microsoft to collect data from users of your
6+
applications. If you use these features, you must comply with applicable law,
7+
including providing appropriate notices to users of your applications together
8+
with a copy of Microsoft's privacy statement. Our privacy statement is located
9+
at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data
10+
collection and use in the help documentation and our privacy statement. Your use
11+
of the software operates as your consent to these practices

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,27 @@
1-
# Project
1+
# PostgreSQL Tools Service
22

3-
> This repo has been populated by an initial template to help get you started. Please
4-
> make sure to update the content to build a great experience for community-building.
3+
The PostgreSQL Tools Service (pgtoolsservice, or PGTS) is an application that provides core functionality for various PostgreSQL Server tools.
4+
* Connection management
5+
* Language Service support using VS Code protocol
6+
* Query execution and resultset management
7+
*
8+
## Telemetry
59

6-
As the maintainer of this project, please make a few updates:
10+
This project collects telemetry data through the related PostgreSQL for VS Code
11+
extenension, which is used to help understand how to improve the product. For
12+
example, this usage data helps to debug issues, such as slow start-up times, and
13+
to prioritize new features. You can disable telemetry as described in the VS
14+
Code [disable telemetry reporting] documentation.
715

8-
- Improving this README.MD file to provide a great experience
9-
- Updating SUPPORT.MD with content about this project's support experience
10-
- Understanding the security reporting process in SECURITY.MD
11-
- Remove this section from the README
16+
Please see [PRIVACY](PRIVACY) for more information about data collection and use.
17+
18+
## Security reporting
19+
20+
Please see [SECURITY.md](SECURITY.md) for information on how to report security vulnerabilities.
21+
22+
## Code of Conduct
23+
24+
Please see [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for information on our code of conduct.
1225

1326
## Contributing
1427

@@ -26,8 +39,10 @@ contact [[email protected]](mailto:[email protected]) with any additio
2639

2740
## Trademarks
2841

29-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
30-
trademarks or logos is subject to and must follow
42+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
43+
trademarks or logos is subject to and must follow
3144
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
3245
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
3346
Any use of third-party trademarks or logos are subject to those third-party's policies.
47+
48+
[disable telemetry reporting]: https://code.visualstudio.com/docs/getstarted/telemetry#_disable-telemetry-reporting

SUPPORT.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,21 @@
1-
# TODO: The maintainer of this repo has not yet edited this file
2-
3-
**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
4-
5-
- **No CSS support:** Fill out this template with information about how to file issues and get help.
6-
- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
7-
- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.
1+
# Support
82

9-
*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
3+
## How to file issues and get help
104

11-
# Support
5+
This project uses GitHub Issues from the related project [PostgreSQL for VS Code](https://github.com/microsoft/vscode-pgsql)
6+
to track bugs and feature requests. Please search the existing issues before
7+
filing new issues to avoid duplicates. For new issues, file your bug or feature
8+
request as a new Issue.
129

13-
## How to file issues and get help
10+
Use the following links to search for existing issues or file a new issue:
1411

15-
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
16-
issues before filing new issues to avoid duplicates. For new issues, file your bug or
17-
feature request as a new Issue.
12+
- [Search existing issues](https://github.com/microsoft/vscode-pgsql/issues)
13+
- [File a new issue](https://github.com/microsoft/vscode-pgsql/issues/new)
1814

19-
For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
20-
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
21-
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
15+
For help and questions about using this project, please use the [GitHub
16+
Discussions](https://github.com/microsoft/vscode-pgsql/discussions) associated
17+
with the PostgreSQL for VS Code repository.
2218

23-
## Microsoft Support Policy
19+
## Microsoft Support Policy
2420

25-
Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
21+
Support for this product is limited to the resources listed above.

0 commit comments

Comments
 (0)