dragonwocky/notion-enhancer
1
0
Fork 0
mirror of https://github.com/notion-enhancer/notion-enhancer.git synced 2025-04-19 11:09:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

modified CONTRIBUTING.md for better formatting and consistent capatilization

Browse Source
This commit is contained in:
DragonL40 2020-11-17 23:10:06 +11:00
parent 206c347838
commit 407d70bda8
1 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
CONTRIBUTING.md
View File

@ -1,33 +1,33 @@
# contributing
# Contributing to notion-enhancer
the enhancer is a tool for the community, so who best to build it but the community?
The enhancer is a tool for the community, so who's best to build it but the community?
these guidelines are designed for smooth communication, management and development on this project.
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
**Found a bug / something isn't working as expected?** Create a
[bug report](https://github.com/dragonwocky/notion-enhancer/issues/new?labels=bug&template=bug-report.md).
> SECURITY ISSUE? (e.g. PERSONAL/NOTION DATA BEING INTERFERED WITH)
> EMAIL ME INSTEAD: [thedragonring.bod@gmail.com](mailto:thedragonring.bod@gmail.com)
**have a cool new feature idea / there's something you just wish you could do?** submit a
**Have a cool new feature idea / there's something you just wish you could do?** Submit a
[feature request](https://github.com/dragonwocky/notion-enhancer/issues/new?labels=enhancement&template=feature-request.md).
> enhancements are applied only locally -
> 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
**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](https://discord.gg/sFWPXtA).
**for information on how to actually create a theme or module with the notion-enhancer api, check the [docs](DOCUMENTATION.md).**
**For information on how to actually create a theme or module with the notion-enhancer api, check the [docs](DOCUMENTATION.md).**
## testing
## Testing
first, remove any other installations of the enhancer: `npm remove -g notion-enhancer`
First, remove any other installations of the enhancer: `npm remove -g notion-enhancer`
to download and install the latest code, run:
To download and install the latest code, run:
```sh
git clone https://github.com/dragonwocky/notion-enhancer
@ -37,61 +37,61 @@ npm link
notion-enhancer apply -y
```
to 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 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:
To remove the dev build, go into the downloaded folder and run:
```sh
notion-enhancer remove -n
npm unlink
```
## conventions
## Coding Conventions
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**.
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](https://semver.org/) 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.
Each module is separately versioned, following the [semver](https://semver.org/) 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
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 `$`.
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.
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.
The master branch is kept consistent with the current release, so all changes should be made to the dev branch.
## review
## Pull Request Reviewing
active core devs will manually look through each pull request and communicate with contributors before merging to
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.
**a) Safe.** System details (e.g. IP, clipboard) and 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?
**b) Functional.** Ask yourself these questions: 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
**c) Bug-free.** Where possible, code should be tested on a variety of platforms and 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.
## translating
## Translating
future versions of the enhancer will have multi-language support.
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.
If you are willing to help with translation, let me know and I'll contact you when I'm ready.
## licensing
## Licensing
this project is distributed under the [MIT](https://choosealicense.com/licenses/mit/) license.
the project as a whole is copyrighted by core devs in the [LICENSE](LICENSE) file.
This project is distributed under the [MIT](https://choosealicense.com/licenses/mit/) license.
The project as a whole is copyrighted by core devs in the [LICENSE](LICENSE) file.
when modifying a file, add your copyright to it in the format:
When modifying a file, add your copyright to it in the format:
```
/*
@ -101,11 +101,11 @@ when modifying a file, add your copyright to it in the format:
*/
```
all code contributed to this repository remains attributed to the contributor,
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,
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.
By opening a pull request in this repository, you agree to the above conditions.
dependencies remain separately licensed to their various authors.
Dependencies remain separately licensed to their various authors.