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

Link to GitHub issue #267

Closed
Rudloff opened this issue Sep 16, 2014 · 6 comments
Closed

Link to GitHub issue #267

Rudloff opened this issue Sep 16, 2014 · 6 comments

Comments

@Rudloff
Copy link

Rudloff commented Sep 16, 2014

Hello,

It would be nice to have a link from the webcompat.com issue to the GitHub issue (and vice-versa).

Regards,

@miketaylr
Copy link
Member

Hey @Rudloff, good suggestion. Right now we have a (basically hidden) key listener to take you to the GitHub issue page. For example, from http://webcompat.com/issues/44 if you press 'g', it will redirect you to webcompat/web-bugs#44.

But I like the idea of linking back to webcompat.com from the GitHub issue.

@karlcow
Copy link
Member

karlcow commented Nov 13, 2014

So to move a bit forward with this.

An issue is created by a POST
It returns a 201Created with a Location: header giving the link and a JSON file with the data which have been recorded. We are interested by the body.
We can grab that Location and sends right away from webcompat.com server a PATCH

Let say that we received (cutting some fields for brevity)

HTTP/1.1 201 Created
Location: https://api.github.com/repos/webcompat/webcompat.com/issues/1`

{ "body": 
'URL: http://shinydemos.com/border-salon/
Browser: Firefox
Version: 31 (Nightly)
Problem type: Looks like the website has a bug.
Site owner: No

Steps […]'
}

We can then sends back to github:

PATCH /repos/webcompat/webcompat.com/issues/1 HTTP/1.1
Host: api.github.com

{ "body": 
'URL: http://shinydemos.com/border-salon/
Browser: Firefox
Version: 31 (Nightly)
Problem type: Looks like the website has a bug.
Site owner: No
WebCompat: http://webcompat.com/issues/1

Steps […]'
}

@miketaylr
Copy link
Member

Very smart.

Do you think we should hide that info when on the webcompat site?

@karlcow
Copy link
Member

karlcow commented Nov 13, 2014

Yes and no.
It could be hidden with a parsing on the client side and adding an appropriate display.
It could be left in order for someone to cut and paste the content in an email with all the body information.

@miketaylr
Copy link
Member

"cut and paste" seems like a use case we want to support by default. Meaning, we shouldn't try to hide it from webcompat.com side.

@calexity calexity modified the milestone: Fix design debt Dec 4, 2014
@miketaylr
Copy link
Member

The link from webcompat.com -> GitHub is solved (via "g" shortcut). GitHub to webcompat.com needs work but should be a separate issue (also needs discussion in terms of design).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants