avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 1 | # Contributing to TW Power Tools |
| 2 | If you're here, thanks for your interest in contributing! There are many ways |
| 3 | you can contribute, and you don't need any technical background for most of |
| 4 | them, so don't feel shy! Any help, even if small, is very much appreciated. |
| 5 | |
| 6 | ## Make feature requests and report issues |
| 7 | If you have some fresh ideas or insight into how to make the extension better, |
Adrià Vilanova Martínez | 178fad7 | 2021-07-09 17:04:23 +0200 | [diff] [blame] | 8 | or you've found a bug (sorry!), you can create a new issue at the Monorail Issue |
| 9 | Tracker: |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 10 | |
Adrià Vilanova Martínez | 178fad7 | 2021-07-09 17:04:23 +0200 | [diff] [blame] | 11 | - https://bugs.avm99963.com/p/twpowertools/issues |
| 12 | |
| 13 | Old issues are still hosted in GitHub, while new ones are hosted in Monorail. |
| 14 | You can view the old ones here: |
| 15 | |
| 16 | - https://www.github.com/avm99963/infinitegforums/issues |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 17 | |
| 18 | If you're reporting a bug, please consider specifying your browser and version, |
| 19 | and 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 |
| 23 | If you speak a language other than English, you can help translate the UI to |
Adrià Vilanova Martínez | f400632 | 2021-08-21 17:22:06 +0200 | [diff] [blame] | 24 | your language! Just go to the following website and select your language to |
| 25 | start translating: |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 26 | |
Adrià Vilanova Martínez | 052bec6 | 2023-02-05 02:15:01 +0100 | [diff] [blame] | 27 | - https://i18n.avm99963.com/projects/tw-power-tools/ |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 28 | |
| 29 | ## Beta test the extension |
| 30 | Releasing an update to the stable channel isn't always an easy task, because |
| 31 | bugs might make its way. As new release candidates are tested in the beta |
| 32 | channel before being promoted to the stable channel, this gives us a last chance |
| 33 | to catch any bugs before the release. This is why it's essential that some |
| 34 | people volunteer to beta test the extension. |
| 35 | |
| 36 | While using the beta version comes with the risk of coming across bugs, those |
| 37 | are usually minor, and you have the opportunity of using newer features before |
| 38 | everyone else! |
| 39 | |
| 40 | *** note |
Adrià Vilanova Martínez | 1686527 | 2024-02-10 13:38:10 +0100 | [diff] [blame] | 41 | **Note:** It isn't recommended to install two versions of the extension at the |
| 42 | same time, as you might end up with duplicate injected components or weird |
| 43 | results. |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 44 | *** |
| 45 | |
| 46 | You can install the beta channel here: |
| 47 | |
| 48 | - https://chrome.google.com/webstore/detail/infinite-scroll-in-tw-bet/memmklnkkhifmflmidnflfcdepamljef |
| 49 | |
Adrià Vilanova Martínez | 1686527 | 2024-02-10 13:38:10 +0100 | [diff] [blame] | 50 | ### Canary channel |
| 51 | If you're brave and want to try the latest of the latest, each night a new |
| 52 | version is automatically uploaded to the Chrome Web Store with the latest |
| 53 | changes which have been uploaded to the codebase. Be warned that it might not |
| 54 | work correctly! |
| 55 | |
| 56 | - https://chromewebstore.google.com/detail/tw-power-tools-canary/phefpbdhiknkamngjffpnebaemanmihf |
| 57 | |
| 58 | To be able to install the Canary channel, you have to |
| 59 | [join the Google Group](https://groups.google.com/g/twpowertools-discuss) |
| 60 | first (feel free to send a request to join!). |
| 61 | |
| 62 | This channel is special because it is the only one where experiments (features |
| 63 | which are currently under development and not yet ready to launch) are |
| 64 | available. To see a list of experiments and enable them, go to the options page |
| 65 | and click the flask icon button. |
| 66 | |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 67 | ## Contribute code changes |
| 68 | If you're a developer and you'd like to contribute code changes, please feel |
| 69 | free to do so! |
| 70 | |
| 71 | You 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ínez | 8aad84f | 2021-08-20 15:11:38 +0200 | [diff] [blame] | 76 | - [Submit changes for review](https://gerrit.avm99963.com/Documentation/intro-gerrit-walkthrough-github.html) |
Adrià Vilanova Martínez | 974189b | 2022-01-17 14:39:31 +0100 | [diff] [blame] | 77 | - [How to test translations](https://developer.chrome.com/docs/extensions/reference/i18n/#how-to-set-browsers-locale) |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 78 | |
| 79 | *** promo |
| 80 | TODO(avm99963): add a link to webext's `manifest.gjson` documentation when it is |
| 81 | created. |
| 82 | *** |
| 83 | |
avm99963 | cf83759 | 2021-02-15 20:02:54 +0100 | [diff] [blame] | 84 | If 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ínez | 974189b | 2022-01-17 14:39:31 +0100 | [diff] [blame] | 86 | [Google group](https://groups.google.com/g/twpowertools-discuss). |
avm99963 | cf83759 | 2021-02-15 20:02:54 +0100 | [diff] [blame] | 87 | I will be more than happy to help you :) |
| 88 | |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 89 | You can get a list of open issues which are recommended for first-time |
| 90 | contributors here: |
| 91 | |
Adrià Vilanova Martínez | 974189b | 2022-01-17 14:39:31 +0100 | [diff] [blame] | 92 | - https://bugs.avm99963.com/p/twpowertools/issues/list?q=label%3AGoodFirstIssue |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 93 | |
| 94 | These issues will let you get familiar with the codebase and are not too |
| 95 | difficult to implement. |
| 96 | |
| 97 | You can also assign yourself any of the open issues which haven't been assigned: |
| 98 | |
Adrià Vilanova Martínez | 974189b | 2022-01-17 14:39:31 +0100 | [diff] [blame] | 99 | - https://bugs.avm99963.com/p/twpowertools/issues/list?q=status%3ANew%20OR%20status%3AAccepted |
avm99963 | ea37fdf | 2021-02-03 01:27:13 +0100 | [diff] [blame] | 100 | |
| 101 | For your information, the following doc contains a description of the release |
| 102 | cycle for this extension, and how it is performed by its maintainers: |
| 103 | |
| 104 | - [Release cycle](developers/release_cycle.md) |