Issue 29331477: Issue 3340 - Add link to issue tracker in the README.md
|
Created:
Nov. 29, 2015, 1:08 a.m. by Erik Modified:
Dec. 21, 2017, 10:48 a.m. Reviewers:
Felix Dahlke Visibility:
Public. |
DescriptionIssue 3340 - Add link to issue tracker in the README.md
Patch Set 1 #
Total comments: 4
Patch Set 2 : Issue 3340 - Add link to issue tracker in the README.md #MessagesTotal messages: 8
You have to send mails after creating a review, otherwise nobody will get notified and people only notice them accidentally. https://codereview.adblockplus.org/29331477/diff/29331478/README.md File README.md (right): https://codereview.adblockplus.org/29331477/diff/29331478/README.md#newcode7 README.md:7: - [Issue Tracker](https://issues.adblockplus.org/) I'm not sure whether this makes much sense - external contributors will usually see the GitHub clone of the repository, and there we don't need to document how to create issues. At the very least, this section should be at the bottom of the document - it's not as important and building and testing requirements. Nit: You have one dash too many below the heading (same with the Building section, not sure why).
https://codereview.adblockplus.org/29331477/diff/29331478/README.md File README.md (right): https://codereview.adblockplus.org/29331477/diff/29331478/README.md#newcode7 README.md:7: - [Issue Tracker](https://issues.adblockplus.org/) On 2015/12/01 14:14:54, Wladimir Palant wrote: > external contributors will usually > see the GitHub clone of the repository, and there we don't need to document how > to create issues. I'm not sure that I understand this. When I went to the github repo first, and didn't understand where the issue tracker was, so I had to google it. > At the very least, this section should be at the bottom of the > document - it's not as important and building and testing requirements. ok I can do this. > Nit: You have one dash too many below the heading (same with the Building > section, not sure why). Ah ok I'll fix this! I was copying the format below :/
https://codereview.adblockplus.org/29331477/diff/29331478/README.md File README.md (right): https://codereview.adblockplus.org/29331477/diff/29331478/README.md#newcode7 README.md:7: - [Issue Tracker](https://issues.adblockplus.org/) On 2015/12/01 18:06:21, Erik wrote: > I'm not sure that I understand this. When I went to the github repo first, and > didn't understand where the issue tracker was, so I had to google it. I see. That's not the typical use case however. Normally, people want to report issues - you can do this on GitHub as usually. If one wants to see existing issues, most of these aren't on GitHub of course. So the documentation has to mention both.
https://codereview.adblockplus.org/29331477/diff/29331478/README.md File README.md (right): https://codereview.adblockplus.org/29331477/diff/29331478/README.md#newcode7 README.md:7: - [Issue Tracker](https://issues.adblockplus.org/) On 2015/12/01 19:18:59, Wladimir Palant wrote: > On 2015/12/01 18:06:21, Erik wrote: > > I'm not sure that I understand this. When I went to the github repo first, > and > > didn't understand where the issue tracker was, so I had to google it. > > I see. That's not the typical use case however. Normally, people want to report > issues - you can do this on GitHub as usually. This isn't possible at the moment, https://github.com/adblockplus/adblockplus does not have issues enabled, so one can only submit pull requests and not simply report a issue.
Hey Wlad, this is ready for another review.
Added Felix to CC. Felix, what do you think - should we really point people to our issue tracker in each README file? I guess we don't want to enable issues on GitHub. Do we have any other options?
I'm removing myself from all reviews, making Felix the reviewer here in case this is still relevant.
This was for the adblockplus repository (according to #3340, which is already closed) which is deprecated now. I do in general think it's important to point to our issue tracker and other things on GitHub, currently it's pretty impossible to make the connection between the issues we refer to in commits you can see there and the actual issues. We might also want to add contribution guides etc. Many projects don't really use GitHub issues, we can look at how they do it. But I guess that's something for a new issue/review. 
|
