Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 2.74 KB

CONTRIBUTING_TO_CODE.md

File metadata and controls

24 lines (21 loc) · 2.74 KB
Raw

Before uploading your files
0. Check all "TODO" comments and for each, resolve it/raise an issue about it and then remove it's comment.

  1. ESLint all the JS files (Cut editor.min.js to desktop; open cmd in /js/ folder; type eslint *.js; when finished, cut the editor.min.js back into the folder)/W3Clint all HTML/CSS files.
  2. Update the version number in options.html and manifest to the latest version number.
  3. Remove/comment console.logs/console.dirs from all JS files. Run Replace function to remove all tab chars at the end of lines - \t+$ Can cause problems like this one
  4. Update the change log in options.html as well as on github
  5. Make sure that the update fixes all the bugs listed for its milestone number.
  6. Check for an update to quill version, and replace the "min.js" and "snow.css" files in our codebase.
  7. Minify all the files except editor.min.js (cut-paste it separately - it is a >200KB file, takes a lot of time to minify).
  8. Copy all imgs from Uncompressed to Compressed in case they were updated.
  9. Testing

After updating the extension
0. Make sure to reply to all people on the support page as well as on the official email ([email protected]), whose errors have been fixed in this updated version.

  1. Update new cards (put them in their respective columns) on the main project for the new issues that were filed while the development. This helps have laser sharp focus for the next update. (Also delete the column that was being used for this update.)
  2. Upload the compressed zipped file under Releases and the uncompressed files to master branch of codebase. useless if I keep committing code frequently enough
  3. Update the known bugs list
  4. Clone the previous folder of the files on the local dev pc and rename the new folder as v_nxt_v_num

Please follow the following conventions:

  1. All class names in HTML must be in small case. Multiple words should be separated by underscore.
  2. Snippet parts should be referred to as "name" and "body" respectively.
  3. All variables names related to a HTML Node should EITHER have $ at the start of their name OR contain the word "node" (not elm) in their name.