build out repository to adhere to OGHO requirements

Author: baadi99

.github/pull_request_template.md

@@ -1,57 +1,43 @@
-*Detailed instructions on how to contribute to the project, if applicable. Must include section about Oracle Contributor Agreement with link and instructions*
-
 # Contributing to this repository
 
-We welcome your contributions! There are multiple ways to contribute.
+Thank you for your interest in contributing to this repository—your efforts are highly appreciated. This document should provide you with everything you need to get started.
+
+## Asking Questions
+
+If you have questions regarding the extension or its API, we highly recommend posting them in the [QA][qa-link] section under the extension's home page in the marketplace.
 
 ## Opening issues
 
 For bugs or enhancement requests, please file a GitHub issue unless it's
 security related. When filing a bug remember that the better written the bug is,
-the more likely it is to be fixed. If you think you've found a security
-vulnerability, do not raise a GitHub issue and follow the instructions in our
-[security policy](./SECURITY.md).
-
-## Contributing code
-
-We welcome your code contributions. Before submitting code via a pull request,
-you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
-your commits need to include the following line using the name and e-mail
-address you used to sign the OCA:
-
-```text
-Signed-off-by: Your Name <you@example.org>
-```
-
-This can be automatically added to pull requests by committing with `--sign-off`
-or `-s`, e.g.
-
-```text
-git commit --signoff
-```
-
-Only pull requests from committers that can be verified as having signed the OCA
-can be accepted.
-
-## Pull request process
-
-1. Ensure there is an issue created to track and discuss the fix or enhancement
- you intend to submit.
-1. Fork this repository.
-1. Create a branch in your fork to implement the changes. We recommend using
- the issue number as part of your branch name, e.g. `1234-fixes`.
-1. Ensure that any documentation is updated with the changes that are required
- by your change.
-1. Ensure that any samples are updated if the base image has been changed.
-1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
- what your changes are meant to do and provide simple steps on how to validate.
- your changes. Ensure that you reference the issue you created as well.
-1. We will assign the pull request to 2-3 people for review before it is merged.
+the more likely it is to be fixed, the [How to file an issue](#how-to-file-an-issue) section provides guidelines to follow when filing issues. If you think you've found a security
+vulnerability, do not raise a GitHub issue and follow the instructions in our [security policy](./SECURITY.md).
+
+### How to file an issue
+
+#### Bugs
+
+- First make sure the issue has not been reported before, by searching in [open issues][issues-link].
+- Provide a detailed report that includes:
+ - A brief summary describing the bug.
+ - Steps to reproduce, along with any sample data, logs, ...etc.
+ - Current versus expected behavior.
+ - Extension version that has the defect e.g. 25.1.0.
+ - OS environment in which the extension was being used e.g. Windows.
+ - Any other information you want to share that is relevant to the issue being reported.
+
+#### Feature requests
+
+Feature and enhancement requests are welcomed, before you file one, take time to gather enough information that justify the request. Examples of the information we look for include:
+- Motivation: document why do you think the feature/enhancement is needed, how will it be useful to users, ...etc.
+- Scope & goals: describe the scope and goals of the feature, and how does it align with our product's scope and goals.
 
 ## Code of conduct
 
-Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
-like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
+Follow the [Golden Rule][golden-rule-link]. If you'd like more specific guidelines, see the [Contributor Covenant Code of Conduct][cccc-link].
 
-[OCA]: https://oca.opensource.oracle.com
-[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/
+<!-- Links -->
+[issues-link]: https://github.com/oracle-samples/sql-developer-vscode/issues
+[qa-link]: https://marketplace.visualstudio.com/items?itemName=Oracle.sql-developer&ssr=false#qna
+[golden-rule-link]: https://en.wikipedia.org/wiki/Golden_Rule
+[cccc-link]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Oracle and/or its affiliates.
+Copyright (c) 2025 Oracle and/or its affiliates.
 
 The Universal Permissive License (UPL), Version 1.0
 

LICENSE.txt

@@ -1,44 +1,22 @@
-*This repository acts as a template for all of Oracle’s GitHub repositories. It contains information about the guidelines for those repositories. All files and sections contained in this template are mandatory, and a GitHub app ensures alignment with these guidelines. To get started with a new repository, replace the italic paragraphs with the respective text for your project.*
+# SQL Developer
+The de-facto query, development, and administration tool for Oracle Database professionals.
 
-# Project name
+The [Oracle SQL Developer Extension for VSCode](https://marketplace.visualstudio.com/items?itemName=Oracle.sql-developer) provides the ability to execute your SQL queries and scripts, perform PL/SQL development, and interact with your database schema objects. Developed over decades with input from more than 6 million users worldwide, SQL Developer brings the features today's developers expect when working with the world's best database.
 
-*Describe your project's features, functionality and target audience*
+# Repository Structure
+- [extension-api](./extension-api): an NPM package that provides Typescript type declarations for the extension API.
+- [samples](./samples): code samples illustrating the extension api, each sample is a standalone VSCode extension.
 
-## Installation
-
-*Provide detailed step-by-step installation instructions. You can name this section **How to Run** or **Getting Started** instead of **Installation** if that's more acceptable for your project*
-
-## Documentation
-
-*Developer-oriented documentation can be published on GitHub, but all product documentation must be published on <https://docs.oracle.com>*
-
-## Examples
-
-*Describe any included examples or provide a link to a demo/tutorial*
-
-## Help
-
-*Inform users on where to get help or how to receive official support from Oracle (if applicable)*
+# Documentation
+Support documentation can be found [here](https://docs.oracle.com/en/database/oracle/sql-developer-vscode/index.html).
 
 ## Contributing
+Please review our [contribution guide](./CONTRIBUTING.md)
 
-*If your project has specific contribution requirements, update the CONTRIBUTING.md file to ensure those requirements are clearly explained*
-
-This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
-
-## Security
-
+# Security
 Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
 
-## License
-
-*The correct copyright notice format for both documentation and software is*
- "Copyright (c) [year,] year Oracle and/or its affiliates."
-*You must include the year the content was first released (on any platform) and the most recent year in which it was revised*
-
-Copyright (c) 2023 Oracle and/or its affiliates.
-
-*Replace this statement if your project is not licensed under the UPL*
+# License
+Copyright (c) 2025 Oracle and/or its affiliates.
 
-Released under the Universal Permissive License v1.0 as shown at
-<https://oss.oracle.com/licenses/upl/>.
+Released under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl/.

README.md

@@ -0,0 +1,2 @@
+node_modules
+.DS_Store

extension-api/.gitignore

@@ -0,0 +1,2 @@
+*
+!dist/*

extension-api/.npmignore

@@ -0,0 +1,35 @@
+Copyright (c) 2025 Oracle and/or its affiliates.
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any
+person obtaining a copy of this software, associated documentation and/or data
+(collectively the "Software"), free of charge and under any and all copyright
+rights in the Software, and any and all patent rights owned or freely
+licensable by each licensor hereunder covering either (i) the unmodified
+Software as contributed to or provided by such licensor, or (ii) the Larger
+Works (as defined below), to deal in both
+
+(a) the Software, and
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+one is included with the Software (each a "Larger Work" to which the Software
+is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create
+derivative works of, display, perform, and distribute the Software and make,
+use, sell, offer for sale, import, export, have made, and have sold the
+Software and the Larger Work(s), and to sublicense the foregoing rights on
+either these or other terms.
+
+This license is subject to the following condition:
+The above copyright notice and either this complete permission notice or at
+a minimum a reference to the UPL must be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.