artsy.github.io
artsy.github.io copied to clipboard
artsy
Comments: Adding comments
I've worked on a few large-scale OSS projects, and I believe that people find it easier to just leave a comment and rely on a contributor to explain a problem rather than consulting the documentation. I consider doing everything you can to make people find their own answers a strong part of defensive open source.
This is an interesting system you've built to handle comments. Do you foresee any problems with using Github Issues for comments while also using Github Issues for issue tracking? Or do you think just having the label "Comment Thread" and using Github's filtering is sufficient for separating the two and keeping things organized?
Additionally, were there any surprises that came up when implementing this system? For example, needing to support some kind of content of a comment (maybe an attached file?) and styling it correctly that didn't cross your mind when first implementing this.
Do you foresee any problems with using Github Issues for comments while also using Github Issues for issue tracking?
ATM, I don't think so - our issues in the artsy github blog are generally a "we should make this blog post sometime" and are really low traffic. I added a label + title prefix to differentiate between them, but I don't think it'll make it harder for any of the non-comment discussions. If it does become a problem, it is not hard to migrate blog post comments into it's own repo too.
Additionally, were there any surprises that came up when implementing this system?
Today, no, but after a few comments maybe. I re-used existing comment threads from inside the issue while figuring out how it should look and feel. So I had a good chunk of real-life data to work against.
That said, I hadn't even considered that using GH issues allows posting images ( and the occasional table) so I'm now considering those an extra freebie 🍡
Having comments on GH issues also made it really easy to hook up to a slack channel - so that I can use my normal stream-based flow of issue management. 🎉
Yeah, I have an issue open on this repo to do it - https://github.com/artsy/artsy.github.io/issues/369
It looks pretty easy, would need to change the header sent off to the request to include a specific attribute. Probably an hour or two at some time for that + the css
Fantastic tutorial, you really simplified the process especially with the gh-commentify app. Thanks!
Hi :wave: https://utteranc.es automates the blog-post to issue linking and allows users to post comments without navigating to GitHub :fire:
This looks cool. I am going to try this on my blog, but let me see first how does it go when I post :)
@breml No we haven't – what we have is still working for us. GitHub discussions seem interesting but, in my personal opinion, they are a solution to a problem that no one really has. If they work for you, that's great 🙌 But in the communities I participate in that have tried them, they haven't been widely used.
