Klipper3d / klipper

Klipper is a 3d-printer firmware
GNU General Public License v3.0
8.99k stars 5.18k forks source link

Update contributing steps (use Discourse first) #6384

Closed KevinOConnor closed 3 months ago

KevinOConnor commented 8 months ago

This changes the documentation (and "reviewer required" github script) to indicate that any new enhancements to Klipper should start with a discussion on Klipper Discourse.

This is in association with a discussion I raised a few months ago on Discourse: https://klipper.discourse.group/t/new-submission-process-for-feature-enhancements/9818

-Kevin

bdistin commented 8 months ago

Are contributors expected to follow the updated guidelines if pull requests are already made?

I may be in the minority, but respectfully if I had to follow these updated guidelines, I probably wouldn't have made my pull request to begin with. I personally have far too much to keep track of that I don't need yet another place to read/interact with to try to improve the things I use. I have only made one tiny pull request, so I understand my opinion carries little-to-no weight. I also understand you and the reviewers likewise have limited time and attention, so I don't think you are necessarily wrong either. My only intent in sharing this opinion is to make sure you are conscious that added friction to contribute may result in fewer people willing to contribute.

neeamradia commented 8 months ago

In reality, all this is going to do is reduce the amount of community contributions to klipper as nobody wants to deal with yet another place to keep track of messages and have another account.

github-actions[bot] commented 7 months ago

Thank you for your contribution to Klipper. Unfortunately, a reviewer has not assigned themselves to this GitHub Pull Request. All Pull Requests are reviewed before merging, and a reviewer will need to volunteer. Further information is available at: https://www.klipper3d.org/CONTRIBUTING.html

There are some steps that you can take now:

  1. Perform a self-review of your Pull Request by following the steps at: https://www.klipper3d.org/CONTRIBUTING.html#what-to-expect-in-a-review If you have completed a self-review, be sure to state the results of that self-review explicitly in the Pull Request comments. A reviewer is more likely to participate if the bulk of a review has already been completed.
  2. Consider opening a topic on the Klipper Discourse server to discuss this work. The Discourse server is a good place to discuss development ideas and to engage users interested in testing. Reviewers are more likely to prioritize Pull Requests with an active community of users.
  3. Consider helping out reviewers by reviewing other Klipper Pull Requests. Taking the time to perform a careful and detailed review of others work is appreciated. Regular contributors are more likely to prioritize the contributions of other regular contributors.

Unfortunately, if a reviewer does not assign themselves to this GitHub Pull Request then it will be automatically closed. If this happens, then it is a good idea to move further discussion to the Klipper Discourse server. Reviewers can reach out on that forum to let you know if they are interested and when they are available.

Best regards, ~ Your friendly GitIssueBot

PS: I'm just an automated script, not a human being.

KevinOConnor commented 7 months ago

Thanks for the feedback. There does seem to be general concern about trying to move development conversations to Klipper Discourse. It seems this change needs more thought, and I suspect there will be further changes to this PR before merging.

-Kevin

KevinOConnor commented 3 months ago

It does not seem that there is consensus on this change, so I am going to close this PR. So, both Discourse and Github PRs seem fine for discussing Klipper code changes. I have disabled the github bot that automatically closes PRs without a reviewer assigned.

-Kevin