treestyletab/CONTRIBUTING.md

51 lines
2.5 KiB
Markdown
Raw Normal View History

2016-02-16 02:13:40 -05:00
# Tree Style Tab contribution guide
2016-02-16 02:36:15 -05:00
If you are pllanning to open a new issue for a bug report or a feature request, please see this document before posting.
2016-02-16 02:13:40 -05:00
## Good, helpful bug reports
A good report is the fastest way to solve a problem.
Even if the problem is very clear for you, possibly unclear for me.
Unclear report can be left unfixed for long time.
2016-02-16 02:36:15 -05:00
Here is a list of typical questions I asked to existing reports:
2016-02-16 02:13:40 -05:00
* Does the problem appear with the [latest develpment build](http://piro.sakura.ne.jp/xul/xpi/nightly/)?
2016-02-16 02:13:40 -05:00
Possibly, problems you met has been resolved already.
2016-02-16 02:24:34 -05:00
On Firefox 43 and later you need to set `xpinstall.signatures.required` to `false` via `about:config`, to try such unsigned packages of development builds.
2016-02-16 02:23:16 -05:00
For Firefox 46 and later, you'll have to try an unbranded Firefox (including Beta, Aurora, and Nightly) to try development builds because the option will be removed on official Firefox 46 and later.
* Does the problem appear without Tab Mix Plus or something other tab related addon?
2016-02-16 02:13:40 -05:00
If a compatibility issue with other addons is reported without such information, it is very hard to be resolved.
See also the next.
* Does the problem appear with a clean profile?
2016-02-16 02:13:40 -05:00
You can start Firefox with temporary clean profile by a command line `-profile`, like: `"C:\Program Filex (x86)\Mozilla Firefox\firefox.exe" -no-remote -profile "%Temp%\FirefoxTemporaryProfile"`
Then, please report the bug with these information:
* Detailed steps to reproduce the problem. For example:
2016-02-16 02:13:40 -05:00
1. Prepare Firefox version XX with plain profile.
2. Install TST version XXXX.
3. Install another addon XXXX version XXXX from "http://....".
4. Click a button on the toolbar.
5. ...
* Expected result.
* Actual result.
* Platform information.
2016-02-16 02:13:40 -05:00
If the problem appear on your multiple platforms, please list them.
* Screenshot images or screencast, if possible.
2016-02-16 02:13:40 -05:00
## Feature requests can be tagged as "out of purpose"
Please see [the readme page](./README.md) before you post a new feature request.
Even if a requested feature is very useful, it is possibly rejected by the project policy.
Instead, please tell me other addon which provide the feature and report a new issue as "compatibility issue with the addon, TST should work together with it".
## Translations, pull requests
2016-02-16 02:36:15 -05:00
If you've fixed a problem you met by your hand, then please send a pull request to me.
2016-02-16 02:13:40 -05:00
2016-02-16 02:36:15 -05:00
Translations also.
Pull requests are easy to merge, than sending ZIP files.
You'll do it without any local application - you can do it on the GitHub.