Skip to content
This repository has been archived by the owner on Jun 15, 2019. It is now read-only.

Latest commit

 

History

History
69 lines (44 loc) · 4.66 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 4.66 KB
Raw

Contributor guidelines

Thinking about contributing to toolbox? Awesome! Here is some information to get you started!

Reporting bugs

We ask that you first make a post in the /r/toolbox subreddit before submitting an issue here. This in order to keep clutter out of the issues on github as much as possible.

Contributing code

New contributions to toolbox are always welcome, there are some guidelines we ask you to follow.

Code/Programming style guidelines

Since toolbox is a project that receives contributions from multiple people from various programming backgrounds it is important to be aware of style conventions. Our programming style guidelines aim is to make it easier for someone who starts work on toolbox to familiarize themselves with the style conventions agreed upon in toolbox.

The document can be found here in our wiki.

Contributing completely new functionality

We welcome new functionality, however it is always possible that someone is already working on something you have thought up or that we have not implemented something deliberately. So if you are considering coding new functionality it is always a good idea to first check. Either on irc or by making an issue about it on github.

Try to make use of existing utility functions

We have a lot of utility functions in toolbox ready to be used for background operations as well as interface building. So when you need a specific sort of function make sure to check if it does not already exist. This is even more important when dealing with reddit DOM manipulation and information scraping. Reddit has the habbit of presenting data in a multitude of different ways depending on the location and the time of the month, a lot of the functionality in our utility code has been refined over the years to account for that.

You can find the documentation for all this on the following locations

Project structure

  • /: root directory containing scripting for building toolbox and configuration for development related things (linting, git configuration files).
  • edgeAssets/: Assets used specifically during the Edge build process.
  • extension/: root directory of the extension itself. Contains the manifests. From here the unpacked extension can be loaded for development.
  • extension/data/: Directory containing the functional code of toolbox. All files starting with tb are toolbox core scripts.
  • extension/data/tbmodule.js: Modules are loaded into toolbox through this.
  • extension/data/tbstorage.js: Everything storage related.
  • extension/data/tbui.js: Handles creating UI elements, wiki page.
  • extension/data/tbutils.js: TBUtils is one of the core blocks on which toolbox is build. It contains most of functions used to interact with reddit. Wiki page.
  • extension/data/background/: Contains extension background scripts
  • extension/data/images/: Images used by toolbox.
  • extension/data/libs/: Contains javascript libraries used by toolbox
  • extension/data/modules/: Contains the individual toolbox modules.
  • extension/data/styles/: Contains all CSS

Loading toolbox into your browser

Chrome
  1. Go to Menu->Tools->Extensions and tick the Developer Mode checkbox.
  2. Click Load unpacked extension and select the /extension folder.
  3. Any time you make changes, you must go back to the Menu->Tools->Extensions page and Reload the extension.
Microsoft Edge
  1. Go to about:flags and tick the Enable extension developer features checkbox.
  2. Click Load extension on the extensions menu and select the /extension.
  3. Any time you make changes, you must go back to the Menu->Extensions page, go to the extension's settings and Reload the extension.
Firefox
  1. Go to about:debugging and tick the Enable add-on debugging checkbox.
  2. Click Load Temporary Add-on and select /extension/manifest.json`.
  3. Any time you make changes, you must go back to the about:debugging page and Reload the extension.