Skip to content

Commit e795129

Browse files
lwasserkierisi
andcommitted
Fix: edits from @kierSi
Co-authored-by: Jesse Mostipak <jesse.maegan@gmail.com>
1 parent 03a97a9 commit e795129

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

community/github/issues.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# pyOpenSci GitHub issue process
22

3-
When possible, pull request and issue submissions and reviews should follow
3+
When possible, pull requests, issue submissions and reviews should follow
44
standard open source workflows. Below are guidelines for handling issues.
55

66
## Guidelines for New Issues
77

88

9-
**Issues in should be as specific as possible:** specifics within an issue help both our future selves and also outside contributors understand the goal or
9+
**Issues should be as specific as possible:** specifics within an issue help both our future selves and also outside contributors understand the goal or
1010
desired outcome associated with addressing the issue. This is important both internally and for issues that we tag as `help-wanted`, which we hope community members will address in pyOpenSci sprints.
1111

1212
To ensure an issue is well-written and specific, include the following details:
@@ -19,15 +19,15 @@ To ensure an issue is well-written and specific, include the following details:
1919

2020
- **Description:** A detailed explanation of the issue or feature request, including context, background information, and the reason for the request. Explain why the issue is important and what problem it solves.
2121

22-
- **Screenshots/Code Samples:** Screenshots, code snippets, links, or any other relevant files that can help in understanding the issue better.
22+
- **Screenshots/Code Samples:** Include screenshots, code snippets, links, or any other relevant files that can help others in understanding the issue better.
2323

24-
- **Possible Solutions/Recommendations:** Any ideas or suggestions for how to address the issue, which can help guide contributors towards a solution.
24+
- **Possible Solutions/Recommendations:** It's helpful to provide any ideas or suggestions for how to address the issue, which can help guide contributors towards a solution.
2525

26-
- **Related Issues or Pull Requests:** References to any related issues or pull requests, providing additional context and understanding of the broader scope of the issue.
26+
- **Related Issues or Pull Requests:** Add references to any related issues or pull requests, which provides additional context and understanding of the broader scope of the issue.
2727

2828
### If you are reporting a code bug
2929

30-
* **Steps to Reproduce (for bugs):** A step-by-step guide on how to reproduce the issue, including relevant code snippets, commands, or configurations.
30+
* **Steps to Reproduce (for bugs):** A step-by-step guide (generally a list or narrative) on how to reproduce the issue, including relevant code snippets, commands, or configurations.
3131

3232
* **Expected vs. Actual Behavior (for bugs):** A description of what you expected to happen and what actually happened. This helps in understanding the discrepancy and the impact of the bug.
3333

@@ -50,7 +50,7 @@ time they have available.
5050
Once the `help-wanted` or `sprintable` issue label is added, the issue will be
5151
automatically added to our
5252
[pyOpenSci help-wanted board](https://github.com/orgs/pyOpenSci/projects/3).
53-
This automation is implemented currently for a single repository (the packaging guide) but we plan to implement it for other repositories using the add-to-project GitHub action.
53+
This automation is implemented currently for a single repository (the packaging guide), but we plan to implement it for other repositories using the add-to-project GitHub action.
5454

5555

5656
:::{note}
@@ -77,6 +77,6 @@ Add section on labels
7777
## Issue Maintenance
7878

7979
Our goal at pyOpenSci is to keep our list of issues current and active.
80-
Quarterly issue cleanup sessions should be implemented to ensure issues are
81-
either being actively addressed or to assess whether older or stale issues can
82-
be potentially closed.
80+
Quarterly issue cleanup sessions are implemented to ensure issues are
81+
either being actively addressed, or to assess whether older or stale issues can
82+
potentially be closed.

0 commit comments

Comments
 (0)