blob: 14da8fc1acb8d4a01c9ec2d0acfe9d716bf2291a [file] [log] [blame] [view]
avm99963ea37fdf2021-02-03 01:27:13 +01001# Contributing to TW Power Tools
2If you're here, thanks for your interest in contributing! There are many ways
3you can contribute, and you don't need any technical background for most of
4them, so don't feel shy! Any help, even if small, is very much appreciated.
5
6## Make feature requests and report issues
7If you have some fresh ideas or insight into how to make the extension better,
Adrià Vilanova Martínez178fad72021-07-09 17:04:23 +02008or you've found a bug (sorry!), you can create a new issue at the Monorail Issue
9Tracker:
avm99963ea37fdf2021-02-03 01:27:13 +010010
Adrià Vilanova Martínez178fad72021-07-09 17:04:23 +020011- https://bugs.avm99963.com/p/twpowertools/issues
12
13Old issues are still hosted in GitHub, while new ones are hosted in Monorail.
14You can view the old ones here:
15
16- https://www.github.com/avm99963/infinitegforums/issues
avm99963ea37fdf2021-02-03 01:27:13 +010017
18If you're reporting a bug, please consider specifying your browser and version,
19and maybe the Javascript console logs (open the Javascript console by pressing
20`[ Ctrl ][ Shift ][ J ]`) for the page where the issue occurred.
21
22## Contribute translations
23If you speak a language other than English, you can help translate the UI to
Adrià Vilanova Martínezf4006322021-08-21 17:22:06 +020024your language! Just go to the following website and select your language to
25start translating:
avm99963ea37fdf2021-02-03 01:27:13 +010026
Adrià Vilanova Martínez052bec62023-02-05 02:15:01 +010027- https://i18n.avm99963.com/projects/tw-power-tools/
avm99963ea37fdf2021-02-03 01:27:13 +010028
29## Beta test the extension
30Releasing an update to the stable channel isn't always an easy task, because
31bugs might make its way. As new release candidates are tested in the beta
32channel before being promoted to the stable channel, this gives us a last chance
33to catch any bugs before the release. This is why it's essential that some
34people volunteer to beta test the extension.
35
36While using the beta version comes with the risk of coming across bugs, those
37are usually minor, and you have the opportunity of using newer features before
38everyone else!
39
40*** note
Adrià Vilanova Martínez16865272024-02-10 13:38:10 +010041**Note:** It isn't recommended to install two versions of the extension at the
42same time, as you might end up with duplicate injected components or weird
43results.
avm99963ea37fdf2021-02-03 01:27:13 +010044***
45
46You can install the beta channel here:
47
48- https://chrome.google.com/webstore/detail/infinite-scroll-in-tw-bet/memmklnkkhifmflmidnflfcdepamljef
49
Adrià Vilanova Martínez16865272024-02-10 13:38:10 +010050### Canary channel
51If you're brave and want to try the latest of the latest, each night a new
52version is automatically uploaded to the Chrome Web Store with the latest
53changes which have been uploaded to the codebase. Be warned that it might not
54work correctly!
55
56- https://chromewebstore.google.com/detail/tw-power-tools-canary/phefpbdhiknkamngjffpnebaemanmihf
57
58To be able to install the Canary channel, you have to
59[join the Google Group](https://groups.google.com/g/twpowertools-discuss)
60first (feel free to send a request to join!).
61
62This channel is special because it is the only one where experiments (features
63which are currently under development and not yet ready to launch) are
64available. To see a list of experiments and enable them, go to the options page
65and click the flask icon button.
66
avm99963ea37fdf2021-02-03 01:27:13 +010067## Contribute code changes
68If you're a developer and you'd like to contribute code changes, please feel
69free to do so!
70
71You can get started by reading the following docs:
72
73- [Set up the development environment](developers/set_up.md)
74- [Build the extension](developers/build.md)
75- [Add a new feature](developers/add_feature.md)
Adrià Vilanova Martínez8aad84f2021-08-20 15:11:38 +020076- [Submit changes for review](https://gerrit.avm99963.com/Documentation/intro-gerrit-walkthrough-github.html)
Adrià Vilanova Martínez974189b2022-01-17 14:39:31 +010077- [How to test translations](https://developer.chrome.com/docs/extensions/reference/i18n/#how-to-set-browsers-locale)
avm99963ea37fdf2021-02-03 01:27:13 +010078
79*** promo
80TODO(avm99963): add a link to webext's `manifest.gjson` documentation when it is
81created.
82***
83
avm99963cf837592021-02-15 20:02:54 +010084If you need any help, mentoring or anything else, send me an email at
85`me [at] avm99963.com` or create a thread in the
Adrià Vilanova Martínez974189b2022-01-17 14:39:31 +010086[Google group](https://groups.google.com/g/twpowertools-discuss).
avm99963cf837592021-02-15 20:02:54 +010087I will be more than happy to help you :)
88
avm99963ea37fdf2021-02-03 01:27:13 +010089You can get a list of open issues which are recommended for first-time
90contributors here:
91
Adrià Vilanova Martínez974189b2022-01-17 14:39:31 +010092- https://bugs.avm99963.com/p/twpowertools/issues/list?q=label%3AGoodFirstIssue
avm99963ea37fdf2021-02-03 01:27:13 +010093
94These issues will let you get familiar with the codebase and are not too
95difficult to implement.
96
97You can also assign yourself any of the open issues which haven't been assigned:
98
Adrià Vilanova Martínez974189b2022-01-17 14:39:31 +010099- https://bugs.avm99963.com/p/twpowertools/issues/list?q=status%3ANew%20OR%20status%3AAccepted
avm99963ea37fdf2021-02-03 01:27:13 +0100100
101For your information, the following doc contains a description of the release
102cycle for this extension, and how it is performed by its maintainers:
103
104- [Release cycle](developers/release_cycle.md)