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 proposal.
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/notion-enhancer/notion-enhancer
cd notion-enhancer
git checkout dev
npm link
notion-enhancer apply -yto update the dev build, go into the downloaded folder and run git pull. (make sure any work-in-progress themes etc. are copied somewhere else safely first.)
to remove the dev build, go into the downloaded folder and run:
notion-enhancer remove -n
npm unlinkthe 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.
the master branch is kept consistent with the current release, so all changes should be made to the dev branch.
active core devs will manually look through each pull request and communicate with contributors before merging to make sure it is:
a) safe. system details (e.g. IP, clipboard) + notion user data are considered private unless directly shared by the user. none of this should be accessed or transmitted to an external server.
b) functional. is there a better way to do this? can extra dependencies be removed or replaced by newer web technologies? how can this be made as user-friendly as possible?
c) bug-free. where possible, code should be tested on a variety of platforms in a variety of situations so it can be confirmed that it won't break anything for the user and is robust enough to handle use by both power users and non-tech-savvy users.
future versions of the enhancer will have multi-language support.
if you are willing to help with translation, let me know and i'll contact you when i'm ready.
this project is distributed under the MIT license. the project as a whole is copyrighted by core devs in the LICENSE file.
when modifying a file, add your copyright to it in the format:
/*
* module or project name
* (c) year name <email> (website)
* under the MIT license
*/
all code contributed to this repository remains attributed to the contributor, but full rights are granted for it to be used under the terms of the MIT license. on the occasion that the contributed code should be removed or overwritten, the contributor's copyright may be removed from the file.
by opening a pull request in this repository, you agree to the above conditions.
dependencies remain separately licensed to their various authors.