Skip to content

Commit

Permalink
Sync with template
Browse files Browse the repository at this point in the history
  • Loading branch information
blakeNaccarato committed Apr 29, 2024
1 parent d3d656f commit eb80bc8
Show file tree
Hide file tree
Showing 23 changed files with 243 additions and 97 deletions.
2 changes: 1 addition & 1 deletion .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
_commit: 903d929
_commit: ae2ebd7
_src_path: gh:blakeNaccarato/copier-python
actions_runner: ubuntu-22.04
active: false
Expand Down
2 changes: 0 additions & 2 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@
},
"extensions": [
"aaron-bond.better-comments@3.0.2",
"bierner.markdown-mermaid@1.22.0",
"bierner.markdown-preview-github-styles@2.0.4",
"charliermarsh.ruff@2024.16.0",
"davidanson.vscode-markdownlint@0.54.0",
Expand All @@ -82,7 +81,6 @@
"stkb.rewrap@1.16.3",
"TakumiI.markdowntable@0.11.0",
"tamasfe.even-better-toml@0.19.2",
"yy0931.mplstyle@1.14.3",
"yzhang.markdown-all-in-one@3.6.2"
]
}
Expand Down
79 changes: 79 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement, such as Blake Naccarato at <blake.naccarato@gmail.com>. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
16 changes: 16 additions & 0 deletions .github/DISCUSSION_TEMPLATE/general.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
labels: ["general"]
body:
- type: "checkboxes"
id: "no-duplicates"
attributes:
label: "Please check for similar discussions first"
options:
- required: True
label: "I [searched](https://github.com/blakeNaccarato/c-therm-tci/discussions/categories/general) and couldn't find an appropriate discussion to participate in instead."
- type: "textarea"
id: "description"
validations:
required: True
attributes:
label: "Description"
description: "Please describe what you would like to discuss."
16 changes: 16 additions & 0 deletions .github/DISCUSSION_TEMPLATE/ideas-for-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
labels: ["documentation"]
body:
- type: "checkboxes"
id: "no-duplicates"
attributes:
label: "Please check for similar discussions first"
options:
- required: True
label: "I [searched](https://github.com/blakeNaccarato/c-therm-tci/discussions/categories/ideas-for-docs) and couldn't find an appropriate discussion to participate in instead."
- type: "textarea"
id: "description"
validations:
required: True
attributes:
label: "Description"
description: "Please describe your idea. Please provide a few details as to how this idea might be implemented."
16 changes: 16 additions & 0 deletions .github/DISCUSSION_TEMPLATE/ideas-for-infrastructure.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
labels: ["infrastructure"]
body:
- type: "checkboxes"
id: "no-duplicates"
attributes:
label: "Please check for similar discussions first"
options:
- required: True
label: "I [searched](https://github.com/blakeNaccarato/c-therm-tci/discussions/categories/ideas-for-infrastructure) and couldn't find an appropriate discussion to participate in instead."
- type: "textarea"
id: "description"
validations:
required: True
attributes:
label: "Description"
description: "Please describe your idea. Please provide a few details as to how this idea might be implemented."
16 changes: 16 additions & 0 deletions .github/DISCUSSION_TEMPLATE/ideas.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
labels: ["enhancement"]
body:
- type: "checkboxes"
id: "no-duplicates"
attributes:
label: "Please check for similar discussions first"
options:
- required: True
label: "I [searched](https://github.com/blakeNaccarato/c-therm-tci/discussions/categories/ideas) and couldn't find an appropriate discussion to participate in instead."
- type: "textarea"
id: "description"
validations:
required: True
attributes:
label: "Description"
description: "Please describe your idea. Please provide a few details as to how this idea might be implemented."
16 changes: 16 additions & 0 deletions .github/DISCUSSION_TEMPLATE/internal.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
labels: ["internal"]
body:
- type: "checkboxes"
id: "no-duplicates"
attributes:
label: "Please check for similar discussions first"
options:
- required: True
label: "I [searched](https://github.com/blakeNaccarato/c-therm-tci/discussions/categories/internal) and couldn't find an appropriate discussion to participate in instead."
- type: "textarea"
id: "description"
validations:
required: True
attributes:
label: "Description"
description: "Please describe the internal matter. Please provide a few details as to how this matter might be handled."
16 changes: 16 additions & 0 deletions .github/DISCUSSION_TEMPLATE/q-a.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
labels: ["question"]
body:
- type: "checkboxes"
id: "no-duplicates"
attributes:
label: "Please check for similar discussions first"
options:
- required: True
label: "I [searched](https://github.com/blakeNaccarato/c-therm-tci/discussions/categories/q-a) and couldn't find an appropriate discussion to participate in instead."
- type: "textarea"
id: "description"
validations:
required: True
attributes:
label: "Description"
description: "Please describe your question"
9 changes: 9 additions & 0 deletions .github/DISCUSSION_TEMPLATE/show-and-tell.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
labels: ["showcase"]
body:
- type: "textarea"
id: "description"
validations:
required: True
attributes:
label: "Description"
description: "Show us what you got! We welcome showcases big and small."
16 changes: 8 additions & 8 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
name: "Bug report"
description: "Report a bug"
name: "🐞 Bug report"
description: "Report a bug. Please don't request features or ask usage questions here."
labels: ["bug"]
body:
- type: "checkboxes"
id: "no-duplicate-issues"
id: "no-duplicates"
attributes:
label: "Please check that this bug hasn't been reported before"
options:
- required: True
label: "I searched previous bug reports [here](https://github.com/blakeNaccarato/c-therm-tci/issues?q=label%3Abug+sort%3Acomments-desc) or [here](https://github.com/search?q=repo%3AblakeNaccarato/c-therm-tci+label%3Abug&type=issues) and didn't find any similar reports."
label: "I searched [here](https://github.com/blakeNaccarato/c-therm-tci/issues?q=label%3Abug+sort%3Acomments-desc) or [here](https://github.com/search?q=repo%3AblakeNaccarato/c-therm-tci+label%3Abug&type=issues) and couldn't find a similar issue."
- type: "checkboxes"
id: "latest-version"
attributes:
label: "Please confirm that this bug affects the latest version"
description: "Please verify the issue is present in the latest version by installing it with `pip install c_therm_tci==0.0.0` and checking. If you have other issues or questions about earlier versions, please visit the [Q&A](https://github.com/blakeNaccarato/c-therm-tci/discussions/new?category=q-a)."
description: "Please verify the issue is present in the latest version by installing it with `pip install c_therm_tci==0.0.0` and checking that the bug is still there"
options:
- required: True
label: "This bug affects version `0.0.0` of `c_therm_tci`."
- type: "checkboxes"
id: "operating-systems"
attributes:
label: "Please indicate which operating system(s) you are using"
description: "You may select more than one"
description: "Please select the most appropriate choice(s) if your exact OS is not listed"
options:
- label: "Linux"
- label: "macOS"
Expand All @@ -31,7 +31,7 @@ body:
validations:
required: True
attributes:
label: "Expected Behavior"
label: "Expected behavior"
description: "Please explain what **should** happen"
- type: "textarea"
id: "what-happened"
Expand All @@ -48,7 +48,7 @@ body:
label: "Steps to reproduce"
description: "Please provide steps that would allow someone to reproduce the issue"
- type: "textarea"
id: "possible-solution"
id: "solution"
attributes:
label: "Possible solution"
description: "Please suggest a possible fix or any ideas you may have about the root cause"
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: "🙏 Ask a question"
about: "Ask for help. Please search related Q&As in case your question has been asked before."
url: "https://github.com/blakeNaccarato/c-therm-tci/discussions/new?category=q-a"
- name: "💡 Share ideas for features, documentation, or infrastructure, or something else."
about: "Please choose the most appropriate discussion category for your concern. Please search for existing similar discussions."
url: "https://github.com/blakeNaccarato/c-therm-tci/discussions/new/choose"
5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature-request.yaml

This file was deleted.

23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/ideas-for-docs.yaml

This file was deleted.

23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/infrastructure-change.yaml

This file was deleted.

25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/internal.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: "⚠️ Internal issue"
description: "Please only select this if you are a maintainer or have been directed to do so."
labels: ["internal"]
body:
- type: "checkboxes"
id: "usage"
attributes:
label: "Please use this form appropriately"
options:
- required: True
label: "I am a maintainer or I have been directed me to use this form."
- type: "checkboxes"
id: "no-duplicates"
attributes:
label: "Please check that this internal matter hasn't already been raised"
options:
- required: True
label: "I searched [here](https://github.com/blakeNaccarato/c-therm-tci/issues?q=label%3Ainternal+sort%3Acomments-desc) or [here](https://github.com/search?q=repo%3AblakeNaccarato/c-therm-tci+label%3Ainternal&type=issues) and couldn't find a similar issue."
- type: "textarea"
id: "description"
validations:
required: True
attributes:
label: "Description"
description: "Please describe the matter. Please provide a few details as to how this matter might be resolved."
9 changes: 9 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security Policy

## Supported Versions

We only support the latest version, but we try to show `DeprecationWarning`s for awhile prior to breaking compatibility.

## Reporting a Vulnerability

If you think you have found a vulnerability, please use [GitHub's security advisory form](<https://github.com/blakeNaccarato/c-therm-tci/security/advisories/new>) or email Blake Naccarato at <blake.naccarato@gmail.com>.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@

## Terms

- [ ] My contribution follows the [contributing guide](https://github.com/blakeNaccarato/c-therm-tci/blob/main/CONTRIBUTING.md).
- [ ] I agree to follow the [code of conduct](https://github.com/blakeNaccarato/c-therm-tci/blob/main/CODE_OF_CONDUCT.md).
- [ ] My contribution follows the [contributing guide](<https://github.com/blakeNaccarato/c-therm-tci/blob/main/CONTRIBUTING.md>).
- [ ] I agree to follow the [code of conduct](<https://github.com/blakeNaccarato/c-therm-tci/blob/main/CODE_OF_CONDUCT.md>).
Loading

0 comments on commit eb80bc8

Please sign in to comment.