README.md - Issue 29331477: Issue 3340 - Add link to issue tracker in the README.md

Delta Between Two Patch Sets: README.md

Issue 29331477: Issue 3340 - Add link to issue tracker in the README.md

Left Patch Set: Created Nov. 29, 2015, 1:08 a.m.

Right Patch Set: Issue 3340 - Add link to issue tracker in the README.md Created Oct. 25, 2016, 8:21 p.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 Adblock Plus for Firefox	1 Adblock Plus for Firefox

2 ========================	2 ========================

3

4 Issues

5 -------

6

7 - [Issue Tracker](https://issues.adblockplus.org/)
Wladimir Palant 2015/12/01 14:14:54 I'm not sure whether this makes much sense - exter 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). Erik 2015/12/01 18:06:21 I'm not sure that I understand this. When I went Show quoted text 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. Show quoted text > 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. Show quoted text > 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 :/ Wladimir Palant 2015/12/01 19:18:59 I see. That's not the typical use case however. No Show quoted text 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. Erik 2016/10/25 18:50:41 This isn't possible at the moment, https://github. Show quoted text 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.
8	3

9 Building	4 Building

10 ---------	5 ---------

11	6

12 ### Requirements	7 ### Requirements

13	8

	9 - [Mercurial](https://www.mercurial-scm.org/) or [Git](https://git-scm.com/) (wh ichever you used to clone this repository)

14 - [Python 2.7](https://www.python.org)	10 - [Python 2.7](https://www.python.org)

15 - [The Jinja2 module](http://jinja.pocoo.org/docs)	11 - [The Jinja2 module](http://jinja.pocoo.org/docs)

16	12

17 ### Building the extension	13 ### Building the extension

18	14

19 Run the following in the project directory:	15 Run the following in the project directory:

20	16

21 ./build.py build	17 ./build.py build

22	18

23 This will create a build with a name in the form _adblockplus-1.2.3.nnnn.xpi_.	19 This will create a build with a name in the form _adblockplus-1.2.3.nnnn.xpi_.

(...skipping 14 matching lines...) Expand all Loading...
38 Running the unit tests	34 Running the unit tests

39 ----------------------	35 ----------------------

40	36

41 To verify your changes you can use the existing	37 To verify your changes you can use the existing

42 [unit test suite](https://hg.adblockplus.org/adblockplustests). The unit tests	38 [unit test suite](https://hg.adblockplus.org/adblockplustests). The unit tests

43 are a separate extension that is installed in addition to Adblock Plus. You can	39 are a separate extension that is installed in addition to Adblock Plus. You can

44 either install the	40 either install the

45 [existing unit test builds](https://adblockplus.org/devbuilds/adblockplustests)	41 [existing unit test builds](https://adblockplus.org/devbuilds/adblockplustests)

46 or clone the repository and create your own build. After installing the unit	42 or clone the repository and create your own build. After installing the unit

47 tests go to extension's options and run the unit tests from there.	43 tests go to extension's options and run the unit tests from there.

	44

	45 Issues

	46 ------

	47

	48 - [Issue Tracker](https://issues.adblockplus.org/)

LEFT	RIGHT