the enhancer is a tool for the community, so who best to build it but the community?
these guidelines are designed for smooth communication, management and development on this project. following them shows respect to the developer/s spending their free time on it, and makes it easiest for them to improve the tool.
found a bug / something isn’t working as expected? create a bug report.
SECURITY ISSUE? (e.g. PERSONAL/NOTION DATA BEING INTERFERED WITH) EMAIL ME INSTEAD: thedragonring.bod@gmail.com
have a cool new feature idea / there’s something you just wish you could do? submit a feature request.
enhancements are applied only locally - features should be designed only to improve the user experience.
know your way around notion/electron/js/css and have some code to contribute? great! read below for guidelines on how to create a helpful pull request and what happens with your code afterwards. it’s probably also helpful to join the discord server.
for information on how to actually create a theme or module with the notion-enhancer api, check the docs.
first, remove any other installations of the enhancer: npm remove -g notion-enhancer
to download and install the latest code, run:
git clone <https://github.com/dragonwocky/notion-enhancercd> notion-enhancergit checkout devnpm linknotion-enhancer apply -y
to remove the dev build, go into the downloaded folder and run:
notion-enhancer remove -nnpm unlink
the enhancer is a core extended by included modules. the core can be further split into the installer and the modloader. modules are either extensions or themes.
each module is separately versioned, following the semver scheme. depending on the content and scale of a contribution, it may constitute an update on its own or may be merged into a larger update.
to keep a consistent & informative code style it is preferred to name variables with snake_case, functions/methods with camelCase, and classes with PascalCase. if a variable is a reference to a DOM element, it may be helpful to prefix it with a $.
some variables beginning with a double underscore are __folder paths and ALL_CAPS variables are constant. this is not required, but these styles should not be used for any other purpose.