|
1 | 1 | # pyOpenSci GitHub issue process
|
2 | 2 |
|
3 |
| -When possible, pull requests, issue submissions and reviews should follow |
4 |
| -standard open source workflows. Below are guidelines for handling issues. |
| 3 | +When possible, GitHub pull requests, issue submissions, and reviews should follow |
| 4 | +standard open source workflows. Below are guidelines for handling issues in the |
| 5 | +pyOpenSci GitHub organization. |
5 | 6 |
|
6 |
| -## Guidelines for New Issues |
| 7 | +## Guidelines for new issues |
7 | 8 |
|
8 |
| - |
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 |
| -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. |
| 9 | +**Issues should be as specific as possible:** Specificity within an issue helps |
| 10 | +both our future selves and outside contributors understand the goal or desired |
| 11 | +outcome associated with addressing the issue. This is important both internally |
| 12 | +and for issues tagged as `help-wanted`, which we hope community members will |
| 13 | +address in pyOpenSci sprints. |
11 | 14 |
|
12 | 15 | To ensure an issue is well-written and specific, include the following details:
|
13 | 16 |
|
14 |
| -- **Clear Title:** A concise and descriptive title summarizing the issue or feature request helps us scan through issues and understand what each issue is about. Below are some example titles that are specific |
| 17 | +- **Clear title:** A concise and descriptive title summarizing the issue or |
| 18 | + feature request helps us scan through issues and understand what each issue is |
| 19 | + about. Below are some example titles that are specific: |
15 | 20 |
|
16 |
| - * `Bug: broken link in link-to-page-here / name of page / document etc` |
17 |
| - * `Fix: confusing paragraph on Python packaging with Hatch` |
18 |
| - * `Add: page on using pixi for dependencies` |
| 21 | + - `Bug: broken link in link-to-page-here / name of page / document etc` |
| 22 | + - `Fix: confusing paragraph on Python packaging with Hatch` |
| 23 | + - `Add: page on using pixi for dependencies` |
19 | 24 |
|
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. |
| 25 | +- **Description:** A detailed explanation of the issue or feature request, |
| 26 | + including context, background information, and the reason for the request. |
| 27 | + Explain why the issue is important and what problem it solves. |
21 | 28 |
|
22 |
| -- **Screenshots/Code Samples:** Include screenshots, code snippets, links, or any other relevant files that can help others in understanding the issue better. |
| 29 | +- **Screenshots/code samples:** Include screenshots, code snippets, links, or |
| 30 | + any other relevant files that can help others in understanding the issue |
| 31 | + better. |
23 | 32 |
|
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. |
| 33 | +- **Possible solutions/recommendations:** It's helpful to provide any ideas or |
| 34 | + suggestions for how to address the issue, which can help guide contributors |
| 35 | + towards a solution. |
25 | 36 |
|
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. |
| 37 | +- **Related issues or pull requests:** Add references to any related issues or |
| 38 | + pull requests, which provides additional context and understanding of the |
| 39 | + broader scope of the issue. |
27 | 40 |
|
28 | 41 | ### If you are reporting a code bug
|
29 | 42 |
|
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. |
| 43 | +- **Steps to reproduce (for bugs):** A step-by-step guide (generally a list or |
| 44 | + narrative) on how to reproduce the issue, including relevant code snippets, |
| 45 | + commands, or configurations. |
31 | 46 |
|
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. |
| 47 | +- **Expected vs. actual behavior (for bugs):** A description of what you |
| 48 | + expected to happen and what actually happened. This helps in understanding |
| 49 | + the discrepancy and the impact of the bug. |
33 | 50 |
|
34 |
| -* **Environment Details (for bugs):** Details about the environment where the issue was observed, such as operating system, Python version, library versions, and any other relevant software/hardware details. |
| 51 | +- **Environment details (for bugs):** Details about the environment where the |
| 52 | + issue was observed, such as operating system, Python version, library |
| 53 | + versions, and any other relevant software/hardware details. |
35 | 54 |
|
36 | 55 | ### If you have permissions, label the issue
|
37 | 56 |
|
38 |
| -While outside contributors will not have permission to label issues, pyOpenSci core team members and volunteers will. Be sure to add appropriate labels to |
39 |
| -issues to make it easier to triage them. |
| 57 | +While outside contributors will not have permission to label issues, pyOpenSci |
| 58 | +core team members and volunteers will. Be sure to add appropriate labels to |
| 59 | +issues to make them easier to triage. |
40 | 60 |
|
41 | 61 | ## Help-wanted / sprintable issues
|
42 | 62 |
|
43 |
| -If an issue is something that anyone in the community could potentially |
44 |
| -address, it's ideal to label the issue with `help-wanted` and/or `sprintable`. |
45 |
| -A sprintable issue refers to an issue that could be completed or worked on |
46 |
| -during a 1-2 day sprint, thus it should be smaller and more confined in scope. |
47 |
| -A help-wanted issue is one that anyone is welcome to work on during whatever |
48 |
| -time they have available. |
| 63 | +If an issue is something that anyone in the community could potentially address, |
| 64 | +it's ideal to label the issue with `help-wanted` and/or `sprintable`. A |
| 65 | +sprintable issue refers to an issue that could be completed or worked on during |
| 66 | +a 1-2 day sprint, thus it should be smaller and more confined in scope. A |
| 67 | +help-wanted issue is one that anyone is welcome to work on during whatever time |
| 68 | +they have available. |
49 | 69 |
|
50 | 70 | Once the `help-wanted` or `sprintable` issue label is added, the issue will be
|
51 | 71 | automatically added to our
|
52 | 72 | [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. |
54 |
| - |
| 73 | +This automation is implemented currently for a single repository (the packaging |
| 74 | +guide), but we plan to implement it for other repositories using the |
| 75 | +add-to-project GitHub action. |
55 | 76 |
|
56 | 77 | :::{note}
|
57 | 78 | The issue will be archived from the project board once it is closed.
|
58 | 79 | :::
|
59 | 80 |
|
60 |
| - |
61 |
| -:::{todo} |
62 |
| -Add link to sprints page when it's online |
| 81 | +:::{seealso} |
| 82 | +[Learn more about pyOpenSci sprint events.](/community/events/sprints) |
63 | 83 | :::
|
64 | 84 |
|
65 |
| -If an issue is unclear, a pyOpenSci staff member or designated community |
66 |
| -member can ask the issue author to provide more information. |
67 |
| - |
68 |
| - |
69 |
| - |
70 |
| - |
71 |
| - |
| 85 | +If an issue is unclear, a pyOpenSci staff member or designated community member |
| 86 | +can ask the issue author to provide more information. |
72 | 87 |
|
73 | 88 | :::{todo}
|
74 |
| -Add section on labels |
| 89 | +Add section on labels once we have things synced up across repos. |
75 | 90 | :::
|
76 | 91 |
|
77 |
| -## Issue Maintenance |
| 92 | +## Issue maintenance |
78 | 93 |
|
79 | 94 | Our goal at pyOpenSci is to keep our list of issues current and active.
|
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 |
| 95 | +Quarterly issue cleanup sessions are implemented to ensure issues are either |
| 96 | +being actively addressed or to assess whether older or stale issues can |
82 | 97 | potentially be closed.
|
0 commit comments