Clarify issue policy #795
Open
Clarify issue policy #795
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added contributing guidelines and issue categorization.
saulshanabrook
requested review from
yihozhang
and removed request for
a team
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new "Contributing" section to the README that documents the egglog project's issue triage process and labeling system, addressing issue #791.
Changes:
- Added a Contributing section to README.md that explains the three-stage issue categorization system (
needs discussion,needs decision, andready for work) - Included guidance for new contributors on finding issues suitable for contribution
- Documented the core developers' process for triaging unlabeled issues
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
|
|
||
| We organize our issues with into three stages: | ||
|
|
||
| 1. [`status:needs discussion`](https://github.com/egraphs-good/egglog/issues?q=state%3Aopen%20label%3A%22status%3Aneeds%20discussion%22): More work refinining this should happen on or offline, before its ready to be considered. |
There was a problem hiding this comment.
The phrase "before its ready" is grammatically incorrect. It should be "before it's ready" (contraction of "it is") or "before it is ready".
Suggested change
| 1. [`status:needs discussion`](https://github.com/egraphs-good/egglog/issues?q=state%3Aopen%20label%3A%22status%3Aneeds%20discussion%22): More work refinining this should happen on or offline, before its ready to be considered. | |
| 1. [`status:needs discussion`](https://github.com/egraphs-good/egglog/issues?q=state%3Aopen%20label%3A%22status%3Aneeds%20discussion%22): More work refinining this should happen on or offline, before it's ready to be considered. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
oflatt
approved these changes
Jan 28, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #791 by creating a policy in the readme for issue categorization and approval by the team.