You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: community/github/issues.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# pyOpenSci GitHub issue process
2
2
3
-
When possible, pull request and issue submissions and reviews should follow
3
+
When possible, pull requests, issue submissions and reviews should follow
4
4
standard open source workflows. Below are guidelines for handling issues.
5
5
6
6
## Guidelines for New Issues
7
7
8
8
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
10
10
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.
11
11
12
12
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:
19
19
20
20
-**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.
21
21
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.
23
23
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.
25
25
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.
27
27
28
28
### If you are reporting a code bug
29
29
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.
31
31
32
32
***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.
33
33
@@ -50,7 +50,7 @@ time they have available.
50
50
Once the `help-wanted` or `sprintable` issue label is added, the issue will be
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.
54
54
55
55
56
56
:::{note}
@@ -77,6 +77,6 @@ Add section on labels
77
77
## Issue Maintenance
78
78
79
79
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
0 commit comments