You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@iggy.apache.org by "hubcio (via GitHub)" <gi...@apache.org> on 2026/01/21 22:48:51 UTC
Updated PR template and contributing guidelines
GitHub user hubcio created a discussion: Updated PR template and contributing guidelines
We've noticed a patterns lately:
- PRs that look fine on the surface but turn into endless review cycles because the author can't really explain or debug their own code,
- Inexperienced devs raising big PRs after only couple of hours of work,
- Low quality of PRs
It's burning maintainers time and will.
So i propose tightening up in https://github.com/apache/iggy/pull/2601:
1. CONTRIBUTING.md - Issue-first, size limits for newcomers, design discussion for risky areas, clearer close policy
2. PR template - Simpler format: why, what changed, did you run it locally, did you use AI
Thoughts?
GitHub link: https://github.com/apache/iggy/discussions/2602
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "hubcio (via GitHub)" <gi...@apache.org>.
GitHub user hubcio added a comment to the discussion: Updated PR template and contributing guidelines
There is no need for it to support dotnet. You can create wrapper scripts that'll call dotnet lints when `*.cs` files are changed, and it can safely pass if no linter is present.
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15570368
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "hubcio (via GitHub)" <gi...@apache.org>.
GitHub user hubcio closed a discussion: Updated PR template and contributing guidelines
We've noticed a patterns lately:
- PRs that look fine on the surface but turn into endless review cycles because the author can't really explain or debug their own code,
- Inexperienced devs raising big PRs after only couple of hours of work,
- Low quality of PRs
It's burning maintainers time and will.
So i propose tightening up in https://github.com/apache/iggy/pull/2601:
1. CONTRIBUTING.md - Issue-first, size limits for newcomers, design discussion for risky areas, clearer close policy
2. PR template - Simpler format: why, what changed, did you run it locally, did you use AI
Thoughts?
GitHub link: https://github.com/apache/iggy/discussions/2602
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "hubcio (via GitHub)" <gi...@apache.org>.
GitHub user hubcio closed the discussion with a comment: Updated PR template and contributing guidelines
Merged https://github.com/apache/iggy/pull/2601. Thanks for the feedback everyone.
The new guidelines are now in place. Closing discussion.
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15653151
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "spetz (via GitHub)" <gi...@apache.org>.
GitHub user spetz added a comment to the discussion: Updated PR template and contributing guidelines
I do fully agree that in recent times, due to the obvious reasons, the lifecycle of OSS projects has been unfortunately disrupted, thus, clearer, even stricter guidelines would be helpful.
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15566816
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "slbotbm (via GitHub)" <gi...@apache.org>.
GitHub user slbotbm added a comment to the discussion: Updated PR template and contributing guidelines
I agree with the sentiment.
That said, currently, pre-commit checks exist only for rust, but the CI defines checks for every language. This means that a contributor needs to run these checks manually, which many of them forget to do. I would propose adding these checks to the pre-commit config as well.
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15565093
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "lukaszzborek (via GitHub)" <gi...@apache.org>.
GitHub user lukaszzborek added a comment to the discussion: Updated PR template and contributing guidelines
Great idea, but only if we can run it for changed foreign clients. I don't think everyone wants to install dotnet sdk to run dotnet format check. Also some fast check in prek and dotnet is not supported (I don't know what they need to support, I'm not very familiar with the prek tool)
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15569785
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "mmodzelewski (via GitHub)" <gi...@apache.org>.
GitHub user mmodzelewski added a comment to the discussion: Updated PR template and contributing guidelines
Agreed, I think prek that we use is pretty flexible. I wonder if it can run some checks based on the changed directory (not everything is always needed).
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15567619
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "slbotbm (via GitHub)" <gi...@apache.org>.
GitHub user slbotbm added a comment to the discussion: Updated PR template and contributing guidelines
According to https://github.com/j178/prek/issues/10 , dotnet is not currently supported by prek
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15569962
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "kparisa (via GitHub)" <gi...@apache.org>.
GitHub user kparisa added a comment to the discussion: Updated PR template and contributing guidelines
+1 @hubcio thanks for putting this together. we need to publish and enforce these guidelines sooner than later.
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15595475
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "numinnex (via GitHub)" <gi...@apache.org>.
GitHub user numinnex added a comment to the discussion: Updated PR template and contributing guidelines
+1 for the policy, things start to get quite ridiculous with how effortless it became to create an "contribution".
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15574928
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "haubur (via GitHub)" <gi...@apache.org>.
GitHub user haubur added a comment to the discussion: Updated PR template and contributing guidelines
I think this is more than reasonable. As a newbie, I very much like the high effort and positive vibes from all the (core) members. This should not be washed out by energy draining work. So these policies can also protect new joiners who want to make a serious effort.
In addition to the things already mentioned in the PR it might be reasonable to make benchmark tests mandatory.
It's usually asked for, but I think it can be valuable to enforce them.
If one added proper unit tests, integration tests and ran iggy-bench against the contribution there is very high likelihood that the implementation is solid.
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15585249
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org
Re: Updated PR template and contributing guidelines
Posted by "hubcio (via GitHub)" <gi...@apache.org>.
GitHub user hubcio added a comment to the discussion: Updated PR template and contributing guidelines
@haubur we can do that, but before I'd like to have a defined standard performance test suite so that we can compare performance using same benchmarks, across many PRs. For now I'll keep it as is and I'll create additional gh issue for this standard suite.
GitHub link: https://github.com/apache/iggy/discussions/2602#discussioncomment-15615194
----
This is an automatically sent email for dev@iggy.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@iggy.apache.org