Skip to content

Commit

Permalink
MAINT - Tone and grammar improvements to templates (#624)
Browse files Browse the repository at this point in the history
  • Loading branch information
trallard authored Oct 18, 2023
1 parent 2753b44 commit e537398
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ body:
Please fill out each section below. This info allows maintainers to diagnose (and fix!) your issue as
quickly as possible.
Before submitting a bug, please make sure the issue hasn't been already addressed by searching through
Before submitting a bug, please make sure the issue hasn't already been addressed by searching through
the past issues in this repository.
- type: textarea
Expand All @@ -40,8 +40,8 @@ body:
label: How to Reproduce the problem?
description: |
Please provide a minimal code example to reproduce the error.
Be as succinct as possible, and provide detailed step by step guidelines to reproduce the bug (using numbered items).
If you have created a GitHub gist, you can paste the link in this box instead.
Be as concise as possible, and provide detailed step-by-step guidelines to reproduce the bug (using numbered items).
If you created a GitHub gist, paste the link in this box instead.
validations:
required: true

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ contact_links:
url: https://conda.store/en/latest/
about: Check out the conda-store documentation
- name: conda-store issue tracker
about: Did you find a bug or want to make a suggestion? Open an issue on our tracker.
about: Did you find a bug or want to suggest something? Please open an issue on our tracker.
url: https://https://github.com/conda-incubator/conda-store/issues/new/choose
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ body:
attributes:
label: Value and/or benefit
description: |
What is the value in adding this feature, and who will benefit from it? Include any information that could help us prioritize the issue.
What is the value of adding this feature, and who will benefit from it? Include any information that could help us prioritize the issue.
This section should contain "why" this issue should be resolved.
validations:
required: true
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/general-issue.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "General issue 💡"
description: "A general template for many kinds of issues."
title: "<title>"
labels: ["type: question 🤔"]
labels: ["needs: triaging 🚦"]

body:
- type: markdown
Expand All @@ -13,7 +13,7 @@ body:
Please fill out each section below. This info allows maintainers to diagnose (and fix!) your issue as
quickly as possible.
Before submitting a bug, please make sure the issue hasn't been already addressed by searching through
Before submitting a bug, please make sure the issue hasn't already been addressed by searching through
the past issues in this repository.
- type: textarea
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/new-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Release captain responsible - <@gh_username>
- [ ] For `conda-store` and `conda-store-server`:

```bash
# note you will need to run this twice, once for each package
# Note you will need to run this twice, once for each package
cd conda-store # or cd conda-store-server
hatch build
twine check dist/*
Expand All @@ -49,8 +49,8 @@ Release captain responsible - <@gh_username>
- [ ] [Start a new GitHub release](https://github.com/conda-incubator/conda-store/releases/new)
- Call the release the current version, e.g. `2023.9.1`
- In the **`Choose a Tag:`** dropdown, type in the release name (e.g., `2023.9.1`) and click "Create new tag"
- In the **`Target:`** dropdown, pin it to the release commit that you've recently pushed.
- Add release notes in the field below[^github-activity], you can copy/paste the changelog from the [CHANGELOG.md](./CHANGELOG.md) file.
- In the **`Target:`** dropdown, pin it to the release commit you've recently pushed.
- Add release notes in the field below[^github-activity]; you can copy/paste the changelog from the [CHANGELOG.md](./CHANGELOG.md) file.
- [ ] Confirm that the release completed
- [The `release` GitHub action job](https://github.com/conda-incubator/conda-store/blob/main/.github/workflows/release.yaml) has completed successfully in the [actions tab](https://github.com/pydata/pydata-sphinx-theme/actions).
- [The `conda-store` PyPI version is updated](https://pypi.org/project/conda-store/)
Expand All @@ -60,4 +60,4 @@ Release captain responsible - <@gh_username>
- [ ] If needed - update `meta.yaml` or `recipe.yaml` and re-render the feedstock.
- [ ] Celebrate, you're done! 🎉
[^github-activity]: If you wish, use [`github-activity` to generate a changelog](https://github.com/choldgraf/github-activity), eg `github-activity conda-incubator/conda-store --since 2023.9.1 --until 2023.10.1`.
[^github-activity]: If you wish, use [`github-activity` to generate a changelog](https://github.com/choldgraf/github-activity), e.g. `github-activity conda-incubator/conda-store --since 2023.9.1 --until 2023.10.1`.

0 comments on commit e537398

Please sign in to comment.