From 7f95c594c094aea4a623528fd5c5eba16b654b79 Mon Sep 17 00:00:00 2001 From: Tyler Date: Mon, 21 Apr 2025 10:04:03 -0700 Subject: [PATCH] More license headers, add a CONTRIBUTING.md file (also fix README.md formatting) (#81) --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ README.md | 2 +- scripts/build.sh | 14 ++++++++++++++ scripts/build_sandbox.sh | 14 ++++++++++++++ scripts/clean.sh | 14 ++++++++++++++ scripts/debug.sh | 14 ++++++++++++++ scripts/start.sh | 14 ++++++++++++++ scripts/start_sandbox.sh | 14 ++++++++++++++ 8 files changed, 117 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..8956a61b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# How to Contribute + +We would love to accept your patches and contributions to this project. + +## Before you begin + +### Sign our Contributor License Agreement + +Contributions to this project must be accompanied by a +[Contributor License Agreement](https://cla.developers.google.com/about) (CLA). +You (or your employer) retain the copyright to your contribution; this simply +gives us permission to use and redistribute your contributions as part of the +project. + +If you or your current employer have already signed the Google CLA (even if it +was for a different project), you probably don't need to do it again. + +Visit to see your current agreements or to +sign a new one. + +### Review our Community Guidelines + +This project follows [Google's Open Source Community +Guidelines](https://opensource.google/conduct/). + +## Contribution process + +### Code Reviews + +All submissions, including submissions by project members, require review. We +use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests) +for this purpose. diff --git a/README.md b/README.md index b24546c0..b8fb78b5 100644 --- a/README.md +++ b/README.md @@ -84,4 +84,4 @@ You can customize the sandbox in `Dockerfile` (e.g. for pre-installed utilities) ### Attaching from VSCode -You can have VSCode (or forks) attach to a running sandbox using the [Dev Containers](https://marketplace.cursorapi.com/items?itemName=ms-vscode-remote.remote-containers) extension. Simply use `Dev Containers: Attach to Running Container ...` command and select your container named `gemini-code-sandbox-#`. Once attached you can open the project folder at `/sandbox/`. You may need the VSCode setting `dev.containers.dockerPath` to be `podman` if using `podman`. Without this setting you may be prompted to install Docker. \ No newline at end of file +You can have VSCode (or forks) attach to a running sandbox using the [Dev Containers](https://marketplace.cursorapi.com/items?itemName=ms-vscode-remote.remote-containers) extension. Simply use `Dev Containers: Attach to Running Container ...` command and select your container named `gemini-code-sandbox-#`. Once attached you can open the project folder at `/sandbox/`. You may need the VSCode setting `dev.containers.dockerPath` to be `podman` if using `podman`. Without this setting you may be prompted to install Docker. diff --git a/scripts/build.sh b/scripts/build.sh index f4f4ce91..9a258d87 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -1,4 +1,18 @@ #!/bin/bash +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + set -euo pipefail # npm install if node_modules was removed (e.g. via npm run clean or scripts/clean.sh) diff --git a/scripts/build_sandbox.sh b/scripts/build_sandbox.sh index a34679e9..47a6749f 100755 --- a/scripts/build_sandbox.sh +++ b/scripts/build_sandbox.sh @@ -1,4 +1,18 @@ #!/bin/bash +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + set -euo pipefail IMAGE=gemini-code-sandbox diff --git a/scripts/clean.sh b/scripts/clean.sh index 1e523087..2dc0232d 100755 --- a/scripts/clean.sh +++ b/scripts/clean.sh @@ -1,4 +1,18 @@ #!/bin/bash +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + set -euo pipefail # remove npm install/build artifacts diff --git a/scripts/debug.sh b/scripts/debug.sh index 45191057..d70dd60f 100755 --- a/scripts/debug.sh +++ b/scripts/debug.sh @@ -1,4 +1,18 @@ #!/bin/bash +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + set -euo pipefail node ./scripts/check-build-status.js diff --git a/scripts/start.sh b/scripts/start.sh index 2c24c61d..51d239af 100755 --- a/scripts/start.sh +++ b/scripts/start.sh @@ -1,4 +1,18 @@ #!/bin/bash +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + set -euo pipefail # check build status, write warnings to file for app to display if needed diff --git a/scripts/start_sandbox.sh b/scripts/start_sandbox.sh index ce405d6e..b6693ce6 100755 --- a/scripts/start_sandbox.sh +++ b/scripts/start_sandbox.sh @@ -1,4 +1,18 @@ #!/bin/bash +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + set -euo pipefail IMAGE=gemini-code-sandbox