Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove all-contributors suggestion from merge notification #225

Merged

Conversation

zeke
Copy link
Contributor

@zeke zeke commented Oct 8, 2020

This PR removes the bit about using the all-contributors bot from the "you merged a PR" workflow.

Resolves #218
Resolves #220

cc @github/docs-engineering

@zeke zeke requested a review from a team as a code owner October 8, 2020 00:42
@zeke zeke added the engineering Will involve Docs Engineering label Oct 8, 2020
Copy link
Contributor

@JasonEtco JasonEtco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this @zeke 👏

Copy link
Contributor

@janiceilene janiceilene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@JasonEtco JasonEtco merged commit eda3650 into main Oct 8, 2020
@JasonEtco JasonEtco deleted the remove-all-contributors-suggestion-from-merge-notification branch October 8, 2020 16:50
@github-actions
Copy link
Contributor

github-actions bot commented Oct 8, 2020

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

If you haven't already, you can add yourself to the list of contributors by creating a new comment in this PR using these instructions. Thanks again! ✨

@jeffmcaffer
Copy link
Contributor

@JasonEtco Thanks for the fix. I do wonder about removing the instructions though. Seems like there's a fair bit of friction without it. Users will have to follow the link, figure out the syntax, pick an emoji (do we care what they pick?) and then add the comment. They'll also need to remember to do that for each different type of contribution.

Is it possible to do one of

  • automatically add the required comment
  • keep something like the previous text but quote the bot command somehow so the allcontributors bot does not try to interpret it

@JasonEtco
Copy link
Contributor

Thanks for that feedback @jeffmcaffer!

automatically add the required comment

We can make a best guess, but this gets a little nuanced when we want to tag the right kind of contribution (code, docs, content, design, etc). So automatically adding it would still require some manual effort, or some up front work to make that guessing smarter based on changed files.

keep something like the previous text but quote the bot command somehow so the allcontributors bot does not try to interpret it

That's what we tried to do, but it seems like the bot is too aggressive in its comment parsing 😅 any comment that mentioned the bot is parsed, and if it fails the bot comments anyway. If we were to write a comment without mentioning the bot, it wouldn't be a copy-pastable example. I'm interested in @janiceilene's thoughts here too - happy to keep experimenting with this!

@jeffmcaffer
Copy link
Contributor

I did a quick look at the project (https://github.com/all-contributors/all-contributors) and didn't see anything detailing how to include instructions in a PR (i.e., quoting). I wonder if they've encountered this scenario? (didn't see anything obvious in the issues).

Question, does GitHub have a way of quoting at mentions in its markup? Like if I want to say "mention me, @jeffmcaffer" in a comment without actually mentioning me, how would I do that?

jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this pull request Oct 6, 2022
* File setup

* Add original content

* Edit content

* Update timescale-cloud/user-management.md

* Apply suggestions from code review

Co-authored-by: Ryan Booz <ryan@timescale.com>

Co-authored-by: Ryan Booz <ryan@timescale.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engineering Will involve Docs Engineering
Projects
None yet
4 participants