blob: 946e2e676e51ddccaef782ee591391762b34fe06 [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,
8or you've found a bug (sorry!), you can create a new issue at the GitHub issue
9tracker:
10
11- https://github.com/avm99963/infinitegforums/issues
12
13If you're reporting a bug, please consider specifying your browser and version,
14and maybe the Javascript console logs (open the Javascript console by pressing
15`[ Ctrl ][ Shift ][ J ]`) for the page where the issue occurred.
16
17## Contribute translations
18If you speak a language other than English, you can help translate the UI to
19your language!
20
21If you're interested in helping with this, please email me at
22`me [at] avm99963.com`.
23
24## Beta test the extension
25Releasing an update to the stable channel isn't always an easy task, because
26bugs might make its way. As new release candidates are tested in the beta
27channel before being promoted to the stable channel, this gives us a last chance
28to catch any bugs before the release. This is why it's essential that some
29people volunteer to beta test the extension.
30
31While using the beta version comes with the risk of coming across bugs, those
32are usually minor, and you have the opportunity of using newer features before
33everyone else!
34
35*** note
36**Note:** It isn't recommended to install the stable and beta version of the
37extension at the same time, as you might end up with duplicate injected
38components or weird results.
39***
40
41You can install the beta channel here:
42
43- https://chrome.google.com/webstore/detail/infinite-scroll-in-tw-bet/memmklnkkhifmflmidnflfcdepamljef
44
45## Contribute code changes
46If you're a developer and you'd like to contribute code changes, please feel
47free to do so!
48
49You can get started by reading the following docs:
50
51- [Set up the development environment](developers/set_up.md)
52- [Build the extension](developers/build.md)
53- [Add a new feature](developers/add_feature.md)
54- [How to test translations](https://developer.chrome.com/docs/extensions/reference/i18n/#how-to-set-your-browsers-locale)
55
56*** promo
57TODO(avm99963): add a link to webext's `manifest.gjson` documentation when it is
58created.
59***
60
avm99963cf837592021-02-15 20:02:54 +010061If you need any help, mentoring or anything else, send me an email at
62`me [at] avm99963.com` or create a thread in the
63[GitHub discussions tab](https://github.com/avm99963/infinitegforums/discussions).
64I will be more than happy to help you :)
65
avm99963ea37fdf2021-02-03 01:27:13 +010066You can get a list of open issues which are recommended for first-time
67contributors here:
68
69- https://github.com/avm99963/infinitegforums/contribute
70
71These issues will let you get familiar with the codebase and are not too
72difficult to implement.
73
74You can also assign yourself any of the open issues which haven't been assigned:
75
76- https://github.com/avm99963/infinitegforums/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee
77
78For your information, the following doc contains a description of the release
79cycle for this extension, and how it is performed by its maintainers:
80
81- [Release cycle](developers/release_cycle.md)