Skip to content

Commit

Permalink
Merge pull request #56 from chocolatey-community/repo-sync/github/def…
Browse files Browse the repository at this point in the history
…ault

(maint) synced file(s) with chocolatey/.github
  • Loading branch information
pauby committed May 14, 2024
2 parents b812a58 + a867552 commit 2dd0ca8
Show file tree
Hide file tree
Showing 11 changed files with 305 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Ask Question In Chat
url: https://ch0.co/community-support
about: Chat with our community and ask your question.
- name: Ask Question By Email
url: http://groups.google.com/group/chocolatey
about: If you prefer to use email, you can ask your question here.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/zFeatureRequest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Enhancement / Feature Request
description: Is there additional functionality you would love us to consider?
labels: ["Enhancement"]

body:
- type: markdown
attributes:
value: |
Ensure you have read over [Submitting Issues](https://github.com/chocolatey/.github/blob/main/SUBMITTING-ISSUES.md) and you are opening this issue in the correct repository.
Please check to see if your problem already exists with a quick search of the issues. Start with one relevant term and then add others if you get too many results.
**NOTE: Keep in mind we have a [Code Of Conduct](https://github.com/chocolatey/.github/blob/main/CODE_OF_CONDUCT.md) that we expect folks to observe when they are looking for support in the Chocolatey community.**
Name your issue appropriately: give it a sentence that reads well enough for anyone seeing this in the release notes to know what it is.
When writing out the issue details, please ensure you are writing it as if you were explaining it to somebody else, even if you will be working on and resolving the issue yourself.
This helps others to understand the reasons for the issue and for it to be searchable in the future.
- type: checkboxes
attributes:
label: Checklist
description: Before continuing, make sure you have done the following.
options:
- label: I have verified this is the correct repository for opening this issue.
required: true
- label: I have verified no other issues exist related to my request.
required: true
- type: textarea
id: problem-related
attributes:
label: Is Your Feature Request Related To A Problem? Please describe.
description: |
In your own words, please describe the problem that would be fixed by introducing the feature or enhancement you request.
validations:
required: false
- type: textarea
id: solution
attributes:
label: Describe The Solution. Why is it needed?
description: |
In your own words, please describe the solution and what you want to happen.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Please include any other information here that you feel may be relevant to the feature you want implemented that is not covered in the previous sections.
- type: textarea
id: related-issues
attributes:
label: Related Issues
description: |
Include any links to other issues that are related to this request.
placeholder: |
- Issue #
- Issue #
validations:
required: false
123 changes: 123 additions & 0 deletions .github/ISSUE_TEMPLATE/zReportIssue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
name: Report Issue
description: Did you find unexpected behavior?
labels: ["Bug"]

body:
- type: markdown
attributes:
value: |
Ensure you have read over [Submitting Issues](https://github.com/chocolatey/.github/blob/main/SUBMITTING-ISSUES.md) and you are opening this issue in the correct repository.
Please check to see if your problem already exists with a quick search of the issues. Start with one relevant term and then add others if you get too many results.
**NOTE: Keep in mind we have a [Code Of Conduct](https://github.com/chocolatey/.github/blob/main/CODE_OF_CONDUCT.md) that we expect folks to observe when they are looking for support in the Chocolatey community.**
Name your issue appropriately: give it a sentence that reads well enough for anyone seeing this in the release notes to know what it is.
When writing out the issue details, please ensure you are writing it as if you were explaining it to somebody else, even if you will be working on and resolving the issue yourself.
This helps others to understand the reasons for the issue and for it to be searchable in the future.
- type: checkboxes
attributes:
label: Checklist
description: Before continuing, make sure you have done the following.
options:
- label: I confirm there are no unresolved issues reported on the [Chocolatey Status page](https://status.chocolatey.org).
required: true
- label: I have verified this is the correct repository for opening this issue.
required: true
- label: I have verified no other issues exist related to my problem.
required: true
- label: I have verified this is not an issue for a specific package.
required: true
- label: I have verified this issue is not security related.
required: true
- label: I confirm I am using **official**, and **not** unofficial, or modified, Chocolatey products.
required: true
- type: textarea
id: current-behavior
attributes:
label: What You Are Seeing?
description: |
In your own words, please describe the problem that you are experiencing. Please include images if possible, as this can give a clearer indication of the problem.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: What is Expected?
description: |
Instead of the behavior that you were seeing, what did you expect would be happening instead?
validations:
required: true
- type: textarea
id: repeatable-steps
attributes:
label: How Did You Get This To Happen?
description: |
Please include a complete set of reproducible steps that another user or maintainer of the repository can follow to get the same behavior that you are seeing.
**NOTE: We may be unable to troubleshoot/respond to issues without reproducible steps. If you do not complete this section, there is a high chance your issue may be closed.**
placeholder: |
1. I ran this command `choco source list`
2. No sources were displayed
3. I then ran this command `choco blah`
4. etc.
validations:
required: true
- type: textarea
id: system-details
attributes:
label: System Details
description: |
Please include as many details about your system as possible. Sometimes, a problem may only happen on specific systems, and this information can be vital to resolving your issue.
At a minimum, include the following pieces of information:
We assume you are using Windows PowerShell, and all example commands given should be run in Windows PowerShell, not in PowerShell Core or CMD.
* Operating System: To get this information run `[System.Environment]::OSVersion.version.tostring()`
* Windows PowerShell Version: Run `$PSVersionTable`
* Chocolatey CLI Version: Run `choco --version`
* Chocolatey Licensed Extension version (Run `choco list chocolatey.extension --exact` (If running a Chocolatey CLI version less than v2.0.0, add `--local-only`)):
* Chocolatey License type (Professional / Business / ?)
* Terminal/Emulator: Some knowledge from you is necessary here. CMD, Windows PowerShell, PowerShell Core, Microsoft Terminal, Cmder, and more are possible known terminals or emulators.
value: |
* Operating System:
* Windows PowerShell version:
* Chocolatey CLI Version:
* Chocolatey Licensed Extension version:
* Chocolatey License type:
* Terminal/Emulator:
validations:
required: true
- type: textarea
id: installed-packages
attributes:
label: Installed Packages
description: |
Sometimes one or more packages installed may be the cause of the problem. Please include the information from the command `choco list ` (If running a Chocolatey CLI version less than v2.0.0, add `--local-only`). If this is part of the installation of Chocolatey CLI or no packages
are installed (not even Chocolatey); please add `N/A` instead.
render: bash
validations:
required: true
- type: textarea
id: output-log
attributes:
label: Output Log
description: |
Please include the log given by Chocolatey CLI when running in debugging and verbose mode. You can run Chocolatey CLI in debugging and verbose mode using the flags `--debug --verbose`. Alternatively, you can find the log file in the following default location: `C:\ProgramData\chocolatey\logs\chocolatey.log`.
Before including the output log, make sure of the following:
- There is no sensitive data shared in the log.
- We need ALL OUTPUT, not just what you may believe is relevant.
- We need ALL OUTPUT (including the configuration information). See https://gist.github.com/ferventcoder/b1300b91c167c8ac8205#file-error-txt-L1-L41 for what we need.
- If it is hard to reproduce with debug/verbose, the log file already logs with those parameters. Just grab the relevant section from the log file.
- Preferably link to a gist instead of pasting the entire log in the issue. You can create a new gist here: https://gist.github.com/ (see https://docs.github.com/en/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists).
render: bash
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Please include any other information here that you feel may be relevant to the problem you are seeing but is not covered in the previous sections.
67 changes: 67 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!--
BEFORE YOU CREATE A PULL REQUEST:
Ensure you have read over [CONTRIBUTING.md](./CONTRIBUTING.md). We provide VERY defined guidance (as such, we strongly adhere to it).
A summary of our expectations:
- You are not submitting a pull request from your MASTER / MAIN branch.
- You are able to sign the Contributor License Agreement (CLA).
- YOUR GIT COMMIT MESSAGE FORMAT IS EXTREMELY IMPORTANT. We have a very defined expectation for this format and are sticklers about it. Really, READ the entire Contributing document. It will save you and us pain.
- Do not reformat code, it makes it hard to see what has changed. Leave the formatting to us.
THANKS! We appreciate you reading the entire Contributing document and not just scanning through it.
Name your pull request appropriately: give it a sentence that reads well enough for anyone seeing this.
if you were explaining it to somebody else. This helps others to understand the reasons for the pull request and for it to be searchable in future.
Please do not remove any of the headings.
If a heading is not applicable then enter N/A: Why it's not applicable
Make sure you have raised an issue for this pull request before continuing.
Please remove all comments before submitting.
-->

## Description Of Changes
<!-- Enter a description of the pull request changes -->

## Motivation and Context
<!-- Why is this change necessary and under what context is it being done -->

## Testing
<!-- How has this change been tested? If multiple different tests have been done please list them.
1. Tested this way
1. Tested that way
-->
### Operating Systems Testing
<!-- If this is a code change, list the operating systems this has been tested on
- Windows Server 2008R2
- Windows 8.1
...
-->

## Change Types Made
<!-- Tick the boxes for the type of changes that have been made -->

* [ ] Bug fix (non-breaking change).
* [ ] Feature / Enhancement (non-breaking change).
* [ ] Breaking change (fix or feature that could cause existing functionality to change).
* [ ] Documentation changes.
* [ ] PowerShell code changes.

## Change Checklist

* [ ] Requires a change to the documentation.
* [ ] Documentation has been updated.
* [ ] Tests to cover my changes, have been added.
* [ ] All new and existing tests passed?
* [ ] PowerShell code changes: PowerShell v2 compatibility checked?

## Related Issue
<!-- Make sure you have raised an issue for this pull request before
continuing. -->

Fixes #

<!-- PLEASE REMOVE ALL COMMENTS BEFORE SUBMITTING -->
10 changes: 10 additions & 0 deletions .templates/default/create/footer.sbn
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{{ if config.create.include_footer }}

### {{ config.create.footer_heading }}

{{ if config.create.milestone_replace_text
replace_milestone_title config.create.footer_content config.create.milestone_replace_text milestone.target.title
else
config.create.footer_content
end
end }}
10 changes: 10 additions & 0 deletions .templates/default/index.sbn
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{{-
include 'release-info'
if milestone.target.description
include 'milestone'
end
include 'issues' | string.rstrip
if template_kind == "CREATE"
include 'create/footer'
end
~}}
5 changes: 5 additions & 0 deletions .templates/default/issue-details.sbn
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### {{ issue_label }}

{{ for issue in issues.items[issue_label]
include 'issue-note'
end }}
6 changes: 6 additions & 0 deletions .templates/default/issue-note.sbn
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{
if issue_label == "Bug" || issue_label == "Bug Fix" || issue_label == "Bug Fixes"
}}- Fix - {{ issue.title }} - see [#{{ issue.public_number }}]({{ issue.html_url }}).
{{ else
}}- {{ issue.title }} - see [#{{ issue.public_number }}]({{ issue.html_url }}).
{{ end -}}
4 changes: 4 additions & 0 deletions .templates/default/issues.sbn
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

{{ for issue_label in issue_labels
include 'issue-details'
end }}
2 changes: 2 additions & 0 deletions .templates/default/milestone.sbn
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

{{ milestone.target.description }}
10 changes: 10 additions & 0 deletions .templates/default/release-info.sbn
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{{
if issues.count > 0
if commits.count > 0
}}As part of this release we had [{{ commits.count }} {{ commits.count | string.pluralize "commit" "commits" }}]({{ commits.html_url }}) which resulted in [{{ issues.count }} {{ issues.count | string.pluralize "issue" "issues" }}]({{ milestone.target.html_url }}?{{ milestone.query_string }}) being closed.
{{ else
}}As part of this release we had [{{ issues.count }} {{ issues.count | string.pluralize "issue" "issues" }}]({{ milestone.target.html_url }}?{{ milestone.query_string }}) closed.
{{ end
else if commits.count > 0
}}As part of this release we had [{{ commits.count }} {{ commits.count | string.pluralize "commit" "commits" }}]({{ commits.html_url }}).
{{ end -}}

0 comments on commit 2dd0ca8

Please sign in to comment.