Skip to content

Commit

Permalink
Merge pull request #83 from DSACMS/nat/sluggify
Browse files Browse the repository at this point in the history
Cookiecutter: Sluggify updated templates with existing variables
  • Loading branch information
natalialuzuriaga authored Apr 4, 2024
2 parents 87e422b + d5839c0 commit cbf892c
Show file tree
Hide file tree
Showing 13 changed files with 43 additions and 46 deletions.
6 changes: 3 additions & 3 deletions tier0/{{cookiecutter.project_slug}}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
2. Check out the `main` branch
3. Create a feature branch
4. Write code and tests for your change
5. From your branch, make a pull request against `cmsgov/cmsgov-example-repo/main`
5. From your branch, make a pull request against `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
6. Work with repo maintainers to get your change reviewed
7. Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
7. Wait for your change to be pulled into `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
8. Delete your feature branch
-->

Expand Down Expand Up @@ -87,7 +87,7 @@ TODO: Example Issue Guides
TODO: Documentation Example
We also welcome improvements to the project documentation or to the existing
docs. Please file an [issue](https://github.com/cmsgov/cmsgov-example-repo/issues).
docs. Please file an [issue](https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues).
-->

<!--
Expand Down
3 changes: 1 addition & 2 deletions tier0/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# {{ cookiecutter.project_name }}

{{ cookiecutter.project_description }}

## About the Project
Expand Down Expand Up @@ -99,7 +98,7 @@ Pull-requests are merged to `main` and the changes are immediately deployed to t

<!--
## Community
The **{project name}** team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.
The {{ cookiecutter.project_name }} team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.
We know that we can learn from a wide variety of communities, including those who will use or will be impacted by the tool, who are experts in technology, or who have experience with similar technologies deployed in other spaces. We are dedicated to creating forums for continuous conversation and feedback to help shape the design and development of the tool.
Expand Down
6 changes: 3 additions & 3 deletions tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
2. Check out the `main` branch
3. Create a feature branch
4. Write code and tests for your change
5. From your branch, make a pull request against `cmsgov/cmsgov-example-repo/main`
5. From your branch, make a pull request against `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
6. Work with repo maintainers to get your change reviewed
7. Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
7. Wait for your change to be pulled into `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
8. Delete your feature branch
-->

Expand Down Expand Up @@ -89,7 +89,7 @@ When creating an issue please try to adhere to the following format:
TODO: Documentation Example
We also welcome improvements to the project documentation or to the existing
docs. Please file an [issue](https://github.com/cmsgov/cmsgov-example-repo/issues).
docs. Please file an [issue](https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues).
-->

## Policies
Expand Down
6 changes: 3 additions & 3 deletions tier1/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## **{Project Name}**
**{project description}**
# {{ cookiecutter.project_name }}
{{ cookiecutter.project_description }}

## About the Project
**{project statement}**
Expand Down Expand Up @@ -85,7 +85,7 @@ The contents of this repository are managed by **{responsible organization(s)}**

<!--
## Community
The **{project name}** team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.
The {{ cookiecutter.project_name }} team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.
We know that we can learn from a wide variety of communities, including those who will use or will be impacted by the tool, who are experts in technology, or who have experience with similar technologies deployed in other spaces. We are dedicated to creating forums for continuous conversation and feedback to help shape the design and development of the tool.
Expand Down
9 changes: 4 additions & 5 deletions tier2/{{cookiecutter.project_slug}}/COMMUNITY_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# {Project Name} Open Source Community Guidelines
# {{ cookiecutter.project_name }} Open Source Community Guidelines

This document contains principles and guidelines for participating in the {Project Name} open source community.
This document contains principles and guidelines for participating in the {{ cookiecutter.project_name }} open source community.

## Principles

Expand All @@ -20,13 +20,12 @@ All community members are expected to adhere to our [Code of Conduct](CODE_OF_CO

Information on contributing to this repository is available in our [Contributing file](CONTRIBUTING.md).

When participating in {Project Name} open source community conversations and spaces, we ask individuals to follow the following guidelines:
When participating in {{ cookiecutter.project_name }} open source community conversations and spaces, we ask individuals to follow the following guidelines:

- When joining a conversation for the first time, please introduce yourself by providing a brief intro that includes:
- your related organization (if applicable)
- your pronouns
- disclosure of any current or potential financial interest in this work
- your superpower, and how you hope to use it for {Project Name}
- your superpower, and how you hope to use it for {{ cookiecutter.project_name }}
- Embrace a culture of learning, and educate each other. We are all entering this conversation from different starting points and with different backgrounds. There are no dumb questions.
- Take space and give space. We strive to create an equitable environment in which all are welcome and able to participate. We hope individuals feel comfortable voicing their opinions and providing contributions and will do our best to recognize and make space for individuals who may be struggling to find space here. Likewise, we expect individuals to recognize when they are taking up significant space and take a step back to allow room for others.
<!-- TODO: Add if your repo has a community chat - Be present when joining synchronous conversations such as our community chat. Why be here if you're not going to _be here_? -->
Expand Down
6 changes: 3 additions & 3 deletions tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
2. Check out the `main` branch
3. Create a feature branch
4. Write code and tests for your change
5. From your branch, make a pull request against `cmsgov/cmsgov-example-repo/main`
5. From your branch, make a pull request against `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
6. Work with repo maintainers to get your change reviewed
7. Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
7. Wait for your change to be pulled into `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
8. Delete your feature branch
-->

Expand Down Expand Up @@ -166,7 +166,7 @@ TODO: What cadence does your project ship new releases? (e.g. one-time, ad-hoc,
TODO: Documentation Example
We also welcome improvements to the project documentation or to the existing
docs. Please file an [issue](https://github.com/cmsgov/cmsgov-example-repo/issues).
docs. Please file an [issue]({{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues).
-->

## Policies
Expand Down
6 changes: 3 additions & 3 deletions tier2/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## **{Project Name}**
**{project description}**
# {{ cookiecutter.project_name }}
{{ cookiecutter.project_description }}

## About the Project
**{project statement}**
Expand Down Expand Up @@ -81,7 +81,7 @@ The contents of this repository are managed by **{responsible organization(s)}**

## Community

The **{project name}** team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.
The {{ cookiecutter.project_name }} team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.

We know that we can learn from a wide variety of communities, including those who will use or will be impacted by the tool, who are experts in technology, or who have experience with similar technologies deployed in other spaces. We are dedicated to creating forums for continuous conversation and feedback to help shape the design and development of the tool.

Expand Down
9 changes: 4 additions & 5 deletions tier3/{{cookiecutter.project_slug}}/COMMUNITY_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# {Project Name} Open Source Community Guidelines
# {{ cookiecutter.project_name }} Open Source Community Guidelines

This document contains principles and guidelines for participating in the {Project Name} open source community.
This document contains principles and guidelines for participating in the {{ cookiecutter.project_name }} open source community.

## Principles

Expand All @@ -20,13 +20,12 @@ All community members are expected to adhere to our [Code of Conduct](CODE_OF_CO

Information on contributing to this repository is available in our [Contributing file](CONTRIBUTING.md).

When participating in {Project Name} open source community conversations and spaces, we ask individuals to follow the following guidelines:
When participating in {{ cookiecutter.project_name }} open source community conversations and spaces, we ask individuals to follow the following guidelines:

- When joining a conversation for the first time, please introduce yourself by providing a brief intro that includes:
- your related organization (if applicable)
- your pronouns
- disclosure of any current or potential financial interest in this work
- your superpower, and how you hope to use it for {Project Name}
- your superpower, and how you hope to use it for {{ cookiecutter.project_name }}
- Embrace a culture of learning, and educate each other. We are all entering this conversation from different starting points and with different backgrounds. There are no dumb questions.
- Take space and give space. We strive to create an equitable environment in which all are welcome and able to participate. We hope individuals feel comfortable voicing their opinions and providing contributions and will do our best to recognize and make space for individuals who may be struggling to find space here. Likewise, we expect individuals to recognize when they are taking up significant space and take a step back to allow room for others.
<!-- TODO: Add if your repo has a community chat - Be present when joining synchronous conversations such as our community chat. Why be here if you're not going to _be here_? -->
Expand Down
6 changes: 3 additions & 3 deletions tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
2. Check out the `main` branch
3. Create a feature branch
4. Write code and tests for your change
5. From your branch, make a pull request against `cmsgov/cmsgov-example-repo/main`
5. From your branch, make a pull request against `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
6. Work with repo maintainers to get your change reviewed
7. Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
7. Wait for your change to be pulled into `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
8. Delete your feature branch
-->

Expand Down Expand Up @@ -161,7 +161,7 @@ authorship metadata will be preserved.
<!-- TODO: Documentation Example
We also welcome improvements to the project documentation or to the existing
docs. Please file an [issue](https://github.com/cmsgov/cmsgov-example-repo/issues).
docs. Please file an [issue](https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues).
-->

## Policies
Expand Down
8 changes: 4 additions & 4 deletions tier3/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## **{Project Name}**
**{project description}**
# {{ cookiecutter.project_name }}
{{ cookiecutter.project_description }}

## About the Project
**{project statement}**
Expand Down Expand Up @@ -78,7 +78,7 @@ The contents of this repository are managed by **{responsible organization(s)}**

## Community

The **{project name}** team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.
The {{ cookiecutter.project_name }} team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.

We know that we can learn from a wide variety of communities, including those who will use or will be impacted by the tool, who are experts in technology, or who have experience with similar technologies deployed in other spaces. We are dedicated to creating forums for continuous conversation and feedback to help shape the design and development of the tool.

Expand All @@ -90,7 +90,7 @@ Principles and guidelines for participating in our open source community are can

<!--
## Governance
Information about how the **{project_name}** community is governed may be found in [GOVERNANCE.md](GOVERNANCE.md).
Information about how the {{ cookiecutter.project_name }} community is governed may be found in [GOVERNANCE.md](GOVERNANCE.md).
-->

## Feedback
Expand Down
9 changes: 4 additions & 5 deletions tier4/{{cookiecutter.project_slug}}/COMMUNITY_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# {Project Name} Open Source Community Guidelines
# {{ cookiecutter.project_name }} Open Source Community Guidelines

This document contains principles and guidelines for participating in the {Project Name} open source community.
This document contains principles and guidelines for participating in the {{ cookiecutter.project_name }} open source community.

## Principles

Expand All @@ -20,13 +20,12 @@ All community members are expected to adhere to our [Code of Conduct](CODE_OF_CO

Information on contributing to this repository is available in our [Contributing file](CONTRIBUTING.md).

When participating in {Project Name} open source community conversations and spaces, we ask individuals to follow the following guidelines:
When participating in {{ cookiecutter.project_name }} open source community conversations and spaces, we ask individuals to follow the following guidelines:

- When joining a conversation for the first time, please introduce yourself by providing a brief intro that includes:
- your related organization (if applicable)
- your pronouns
- disclosure of any current or potential financial interest in this work
- your superpower, and how you hope to use it for {Project Name}
- your superpower, and how you hope to use it for {{ cookiecutter.project_name }}
- Embrace a culture of learning, and educate each other. We are all entering this conversation from different starting points and with different backgrounds. There are no dumb questions.
- Take space and give space. We strive to create an equitable environment in which all are welcome and able to participate. We hope individuals feel comfortable voicing their opinions and providing contributions and will do our best to recognize and make space for individuals who may be struggling to find space here. Likewise, we expect individuals to recognize when they are taking up significant space and take a step back to allow room for others.
<!-- TODO: Add if your repo has a community chat - Be present when joining synchronous conversations such as our community chat. Why be here if you're not going to _be here_? -->
Expand Down
6 changes: 3 additions & 3 deletions tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
2. Check out the `main` branch
3. Create a feature branch
4. Write code and tests for your change
5. From your branch, make a pull request against `cmsgov/cmsgov-example-repo/main`
5. From your branch, make a pull request against `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
6. Work with repo maintainers to get your change reviewed
7. Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
7. Wait for your change to be pulled into `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
8. Delete your feature branch
-->

Expand Down Expand Up @@ -161,7 +161,7 @@ authorship metadata will be preserved.
<!-- TODO: Documentation Example
We also welcome improvements to the project documentation or to the existing
docs. Please file an [issue](https://github.com/cmsgov/cmsgov-example-repo/issues).
docs. Please file an [issue](https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues).
-->

## Policies
Expand Down
Loading

0 comments on commit cbf892c

Please sign in to comment.