From 05dca8fe8038c36927007280db1b17f8a6ee743b Mon Sep 17 00:00:00 2001 From: "Celina G. Val" Date: Tue, 4 Jun 2024 11:16:06 -0700 Subject: [PATCH] Add contest book (#6) Add initial book and a workflow to build / deploy the book. I also created a few other configurations that we were missing. Co-authored-by: Jaisurya Nanduri <91620234+jaisnan@users.noreply.github.com> --- .github/CODEOWNERS | 4 +++ .github/PULL_REQUEST_TEMPLATE.md | 10 ++++++ .github/dependabot.yml | 11 +++++++ .gitignore | 54 ++++++++++++++++++++++++++++++++ 4 files changed, 79 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/dependabot.yml create mode 100644 .gitignore diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000000000..f1a8a10bcd0f4 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,4 @@ +# Copyright Kani Contributors +# SPDX-License-Identifier: Apache-2.0 OR MIT + +* @model-checking/kani-devs diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000000..6ab0f7b948845 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ +> Please add a description of your PR. +> If this is a solution to an open challenge, please explain your solution. +> +> Don't forget to check our book to ensure your solution satisfy the overall +> requirements as well as the challenge success criteria. +> + +Resolves #ISSUE-NUMBER + +By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000000000..7647990dd685a --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# Copyright Kani Contributors +# SPDX-License-Identifier: Apache-2.0 OR MIT + +# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file + +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000..fa490af4c013e --- /dev/null +++ b/.gitignore @@ -0,0 +1,54 @@ +# Copyright Kani Contributors +# SPDX-License-Identifier: Apache-2.0 OR MIT + +## File system +.DS_Store +desktop.ini + +## Editor +*.swp +*.swo +Session.vim +.cproject +.idea +*.iml +.vscode +.project +.favorites.json +.settings/ +*.orig +*.rej + +## Build +/book/ +/build/ +/target +*.rlib +*.rmeta +*.mir + +## Temporary files +*~ +\#* +\#*\# +.#* + +## Python +__pycache__/ +*.py[cod] +*$py.class + +## Node +node_modules +package-lock.json + +# Tools +## Kani +*.out + + +# Added by cargo +# +# already existing elements were commented out + +#/target