Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ RUN mkdir -p -m 755 /etc/apt/keyrings \
&& arch=$(dpkg --print-architecture) \
&& node_version=24.x \
&& echo "deb [arch=$arch signed-by=/etc/apt/keyrings/microsoft.gpg] https://packages.microsoft.com/repos/azure-cli/ $(lsb_release -cs) main" | tee /etc/apt/sources.list.d/azure-cli.list > /dev/null \
&& echo "deb [arch=$arch signed-by=/etc/apt/keyrings/microsoft.gpg] https://packages.microsoft.com/ubuntu/$(lsb_release -rs)/prod $(lsb_release -cs) main" | tee /etc/apt/sources.list.d/microsoft-prod.list > /dev/null \
&& echo "deb [arch=$arch signed-by=/etc/apt/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
&& echo "deb [arch=$arch signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null \
&& echo "deb [arch=$arch signed-by=/etc/apt/keyrings/github_git-lfs-archive-keyring.gpg] https://packagecloud.io/github/git-lfs/ubuntu/ $(. /etc/os-release && echo "$VERSION_CODENAME") main" | tee /etc/apt/sources.list.d/github_git-lfs.list > /dev/null \
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/main.yml.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@ jobs:
contents: read
actions: write
id-token: write
attestations: write
1 change: 0 additions & 1 deletion .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ jobs:
actions: write
id-token: write
attestations: write
id-token: write

copier:
uses: ./.github/workflows/copier.yml
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/pr.yml.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ jobs:
permissions:
contents: read
actions: write
id-token: write
attestations: write
57 changes: 0 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,63 +41,6 @@ Visit the documentation:

:point_right: Go to [new project](https://microsoft.github.io/cookie-doh/getting_started/) for first steps!

## :space_invader: Codespaces

Learn about [GitHub Codespaces](https://docs.github.com/en/codespaces) and [DevPod](https://devpod.sh/).

:point_right: Click below to clone or fork this repository automatically and start developing:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/cookie-doh)

[![Open in DevPod!](https://devpod.sh/assets/open-in-devpod.svg)](https://devpod.sh/open#https://github.com/microsoft/cookie-doh)

## :gear: Devcontainer

Learn about [Devcontainers](https://containers.dev).
Requires [Docker](https://www.docker.com/get-started/) installed on your local machine.

:point_right: Follow instructions for [VSCode](https://code.visualstudio.com/docs/devcontainers/tutorial)
and/or [PyCharm](https://www.jetbrains.com/help/pycharm/connect-to-devcontainer.html).

## :computer: Local development

:point_right: Follow [instructions](https://microsoft.github.io/cookie-doh/dev_setup)
to set up your local environment.

## :hammer_and_wrench: Development tools

Cookie-doh uses and generates projects with the following tools to help the development experience:

* [uv](https://docs.astral.sh/uv/) for dependency management, virtual environments and
packaging. Configured so that your code is readily importable.
* [ruff](https://docs.astral.sh/ruff/) for formatting and linting: helps you write clean and uniform code across collaborations.
* [pytest](https://docs.pytest.org/en/stable/) for testing: ensures your code is working as expected.
* [pyright](https://github.com/microsoft/pyright) for static annotations: helps identify simple errors and makes your code more readable!
* [codespell](https://github.com/codespell-project/codespell) for spell checking: pinpoints spelling errors across code and documents.
* [CI workflows](https://en.wikipedia.org/wiki/Continuous_integration): automates validation when you submit a PR or merge to `main` branch.

Optional tools (configurable when you create a new project):

* [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) for beautiful markdown documentation builds (like [cookie-doh](https:microsoft.github.io/cookie-doh)'s).
* [pre-commit](https://pre-commit.com/) for quick validation checks and fixes before committing.
* [commitizen](https://commitizen-tools.github.io/commitizen/)
for writing [conventional commits](https://www.conventionalcommits.org/), to help write better commit messages
and track changes through [time](https://github.com/microsoft/cookie-doh/blob/main/CHANGELOG.md).

## :mountain: Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

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.

## :balance_scale: Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
Expand Down
79 changes: 0 additions & 79 deletions README.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -22,86 +22,7 @@ https://{{ organization }}.github.io/{{ project_name }}/
## :floppy_disk: Source Code
https://github.com/{{ organization }}/{{ project_name }}/
{%- endif %}


## :space_invader: Codespaces

We provide a configured devcontainer for you to use in your new project and/or cookie-doh itself.
You can create a container image with all the necessary dependencies,
and use it for remote development in a remote node with [GitHub Codespaces](https://docs.github.com/en/codespaces)
or [DevPod](https://devpod.sh/).

:point_right: Click below to clone or fork this repository automatically and start developing:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/{{organization}}/{{project_name}})

[![Open in DevPod!](https://devpod.sh/assets/open-in-devpod.svg)](https://devpod.sh/open#https://github.com/{{organization}}/{{project_name}})


## :gear: Devcontainer

Alternatively, you can build a local container directly and use it in VSCode and/or
PyCharm without developing in a remote node or setting up a local environment.

Learn about [Devcontainers](https://containers.dev/).
Requires [Docker](https://www.docker.com/get-started/) installed on your local machine.

:point_right: Follow instructions for [VSCode](https://code.visualstudio.com/docs/devcontainers/tutorial)
and/or [PyCharm](https://www.jetbrains.com/help/pycharm/connect-to-devcontainer.html).


## :computer: Local development

The only required dependency is [uv](https://docs.astral.sh/uv/getting-started/installation/).
However, we recommend installing some extra dependencies to improve the development experience.

:point_right: Follow [instructions](https://microsoft.github.io/cookie-doh/dev_setup)
to set up your local environment.


## :hammer_and_wrench: Description of development tools:

{{ project_name}} uses the following tools to facilitate the development experience:

* [uv](https://docs.astral.sh/uv/) for Python management, dependency management, virtual environments and
packaging, i.e., makes your code readily importable!
* [ruff](https://github.com/astral-sh/ruff) for formatting and linting: helps you write clean and uniform code for better consistency (and it's fast!).
* [pytest](https://docs.pytest.org/en/stable/) for testing: ensures your code is working as expected!
* [pyright](https://github.com/microsoft/pyright) for static annotations: helps identify simple errors, but more importantly,
makes your code more readable!
* [codespell](https://github.com/codespell-project/codespell) for spell checking: pinpoints spelling errors across code and documents.
* [CI workflows](https://en.wikipedia.org/wiki/Continuous_integration): automates validation when you submit a PR or merge to `main` branch.
{% if documentation -%}
* [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) for beautiful markdown documentation builds (like [cookie-doh](https:microsoft.github.io/cookie-doh)'s).
{% endif -%}
{% if precommit -%}
* [pre-commit](https://pre-commit.com/) for quick validation checks and fixes before committing.
{% endif -%}
{% if commitizen -%}
* [commitizen](https://commitizen-tools.github.io/commitizen/)
for writing [conventional commits](https://www.conventionalcommits.org/), to help write better commit messages
and track changes through [time](https://github.com/microsoft/cookie-doh/blob/main/CHANGELOG.md).
{% endif -%}


{% if organization == 'microsoft' %}
--------------------------------------------

## :mountain: Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

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.


## :balance_scale: Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
Expand Down