How to contribute

[ghxstweb]

Not sure if this is the right place, but are the developer's/ maintainers of the atom minimap available to provide some material on how a user might be able to contribute to minimap development? What parts of the code need to be looked at, how to decipher the code, API, etc. Thanks in advance for your help!

[mzivic7]

Here is what I found after digging through source for some time:

• To setup your environment:
  First install atom/pulsar
  Install npm
  Using npm install parcel: npm install -g parcel
  Parcel will be used to minify code into files inside dist/ directory (with parcel build --target main ./lib/main.js)
  Install dependencies (run inside project directory):

  • atom: apm install --production
  • pulsar: pulsar -p install --production

  Now parcel would throw "build failed" and hint a solution, so edit:
  node_modules/atom-utils-plus/package.json
  and after line 41 ("dependencies":) add "atom": "^1.40.11",
  Again parcel complains that terser-config-atomic is missing, so just remove .terserrc.js file from project directory

• The relevant code is inside lib/ directory

• After changes to code in lib/ are made, to rebuild:
  Use parcel to rebuild minified code in dist/,(run inside project directory):
  parcel build --target main ./lib/main.js

• To manually add it to atom/pulsar for testing/use:
  Remove old minimap package
  Put project directory in [atom/pulsar-home-dir]/packages
  Restart atom/pulsar to reload packages

I hope this will be useful to future contributors.