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

📝 Documentation: example replies.yml #52

Open
2 tasks done
Pinjasaur opened this issue Nov 2, 2022 · 4 comments
Open
2 tasks done

📝 Documentation: example replies.yml #52

Pinjasaur opened this issue Nov 2, 2022 · 4 comments
Labels
good first issue Good for newcomers, please hop on! status: accepting prs Please, send a pull request to resolve this! type: documentation Improvements or additions to docs

Comments

@Pinjasaur
Copy link
Contributor

Bug Report Checklist

Overview

An example and/or minimal spec for what the replies.yml file is supposed to look like. Based on the source code, it looks like body and name keys are required?

children: [reply.name],
className:
"select-menu-item-heading css-truncate css-truncate-target",
}),
createElement("span", {
children: [reply.body],

Additional Info

(Also based on the replies.yml in this repo 🙂)

@Pinjasaur
Copy link
Contributor Author

Ah, I see there's a bit 🤌 of overlap with #9.

@JoshuaKGoldberg
Copy link
Owner

Indeed, but you filed this one and I appreciate you filing it, so we can close that one as the dup 😄.

Recapping my hopes:

The README.md is now pretty sparse. Let's add...

  • an explanation of how to use the extension
  • a sample .github/replies.yml
  • a link to this repo's replies
  • a gif/video of someone using it

Feel free to just post part of that (say, just the sample code). We can file a followup for the rest.

@JoshuaKGoldberg
Copy link
Owner

@all-contributors please add @Pinjasaur for docs.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action.
Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed.
...and of course, thank you for contributing! 💙

Copy link
Contributor

@JoshuaKGoldberg

I've put up a pull request to add @Pinjasaur! 🎉

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers, please hop on! status: accepting prs Please, send a pull request to resolve this! type: documentation Improvements or additions to docs
Projects
None yet
Development

No branches or pull requests

2 participants