Skip to content

Commit

Permalink
fix: edits to gh issues page
Browse files Browse the repository at this point in the history
  • Loading branch information
lwasser committed Aug 13, 2024
1 parent ca1a8d8 commit fda1b69
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 61 deletions.
17 changes: 2 additions & 15 deletions community/github/intro.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,11 @@
# GitHub

:::{todo}
1. for extra contributors - A pyOpenSci community member will review your post / contribution. you don't need to request a review.
1.
:::


pyOpenSci has a suite of GitHub repositories (repos) that support pyOpenSci processes and content including:
pyOpenSci has a suite of GitHub repositories (repos) that support pyOpenSci
processes and content including:

* website content
* tools that track contributors and keep the website up to date
* peer review

This section of the guidebook discusses our GitHub organization, and processes
for adding and managing content and infrastructure across the organization.


:::{toctree}
:glob:
:maxdepth: 2

*
:::
97 changes: 56 additions & 41 deletions community/github/issues.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,97 @@
# pyOpenSci GitHub issue process

When possible, pull requests, issue submissions and reviews should follow
standard open source workflows. Below are guidelines for handling issues.
When possible, GitHub pull requests, issue submissions, and reviews should follow
standard open source workflows. Below are guidelines for handling issues in the
pyOpenSci GitHub organization.

## Guidelines for New Issues
## Guidelines for new issues


**Issues should be as specific as possible:** specifics within an issue help both our future selves and also outside contributors understand the goal or
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.
**Issues should be as specific as possible:** Specificity within an issue helps
both our future selves and outside contributors understand the goal or desired
outcome associated with addressing the issue. This is important both internally
and for issues tagged as `help-wanted`, which we hope community members will
address in pyOpenSci sprints.

To ensure an issue is well-written and specific, include the following details:

- **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
- **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:

* `Bug: broken link in link-to-page-here / name of page / document etc`
* `Fix: confusing paragraph on Python packaging with Hatch`
* `Add: page on using pixi for dependencies`
- `Bug: broken link in link-to-page-here / name of page / document etc`
- `Fix: confusing paragraph on Python packaging with Hatch`
- `Add: page on using pixi for dependencies`

- **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.
- **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.

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

- **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.
- **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.

- **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.
- **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.

### If you are reporting a code bug

* **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.
- **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.

* **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.
- **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.

* **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.
- **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.

### If you have permissions, label the issue

While outside contributors will not have permission to label issues, pyOpenSci core team members and volunteers will. Be sure to add appropriate labels to
issues to make it easier to triage them.
While outside contributors will not have permission to label issues, pyOpenSci
core team members and volunteers will. Be sure to add appropriate labels to
issues to make them easier to triage.

## Help-wanted / sprintable issues

If an issue is something that anyone in the community could potentially
address, it's ideal to label the issue with `help-wanted` and/or `sprintable`.
A sprintable issue refers to an issue that could be completed or worked on
during a 1-2 day sprint, thus it should be smaller and more confined in scope.
A help-wanted issue is one that anyone is welcome to work on during whatever
time they have available.
If an issue is something that anyone in the community could potentially address,
it's ideal to label the issue with `help-wanted` and/or `sprintable`. A
sprintable issue refers to an issue that could be completed or worked on during
a 1-2 day sprint, thus it should be smaller and more confined in scope. A
help-wanted issue is one that anyone is welcome to work on during whatever time
they have available.

Once the `help-wanted` or `sprintable` issue label is added, the issue will be
automatically added to our
[pyOpenSci help-wanted board](https://github.com/orgs/pyOpenSci/projects/3).
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.

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.

:::{note}
The issue will be archived from the project board once it is closed.
:::


:::{todo}
Add link to sprints page when it's online
:::{seealso}
[Learn more about pyOpenSci sprint events.](/community/events/sprints)
:::

If an issue is unclear, a pyOpenSci staff member or designated community
member can ask the issue author to provide more information.





If an issue is unclear, a pyOpenSci staff member or designated community member
can ask the issue author to provide more information.

:::{todo}
Add section on labels
Add section on labels once we have things synced up across repos.
:::

## Issue Maintenance
## Issue maintenance

Our goal at pyOpenSci is to keep our list of issues current and active.
Quarterly issue cleanup sessions are implemented to ensure issues are
either being actively addressed, or to assess whether older or stale issues can
Quarterly issue cleanup sessions are implemented to ensure issues are either
being actively addressed or to assess whether older or stale issues can
potentially be closed.
8 changes: 3 additions & 5 deletions community/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Organization Handbook


:::{toctree}
:hidden:
:caption: Social Media Section
Expand All @@ -9,20 +8,19 @@ Social Media <social>
Slack <slack>
:::


:::{toctree}
:hidden:
:caption: GitHub Section
:caption: GitHub Processes

GitHub <github/intro>
Our Repos <github/our-repositories>
GitHub Issue Guidelines <github/issues>
:::


:::{toctree}
:hidden:
:caption: pyOpenSci Events

Events <events/intro>
pyOpenSci Sprints <events/sprints>

:::

0 comments on commit fda1b69

Please sign in to comment.