From d0950a164e8fd98c6109a7ffef8f0cc4384df59b Mon Sep 17 00:00:00 2001 From: Giulio Starace Date: Tue, 19 Nov 2019 15:25:52 -0300 Subject: [PATCH] add ideas for new features --- CONTRIBUTING.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c98245..ea82117 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,18 @@ Please feel free to let me know if you have any suggestions on how we can make c When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. -## Pull Request Process +## What should I work on? + +Here is just a list of desired features that the extension is currently missing. Let me know if you have more ideas. The list is by no means exhaustive or mandatory. + +- Support for browsers other than Firefox and Chrome +- Option to evaluate every single `

` element on the page at once. As [Andrej Karpathy suggested](https://twitter.com/karpathy/status/1192169928079503360?s=20) + > Or maybe it just highlights the areas in walls of text that have a low log prob to help manage your attention. +- Incorporation of models other than GPT-2 to increase the range of bots that the detector is robust to. + +## Technicalities + +### Pull Request Process The pull request process is pretty simple at the moment; simply ensure you follow the following guidelines @@ -18,7 +29,7 @@ The pull request process is pretty simple at the moment; simply ensure you follo 4. All new/edited code _must_ follow [variable, function an class naming](#variable-function-and-class-naming) conventions. 5. Please ensure you update the version in [manifest.json](./GPTrueOrFalse/src/manifest.json) accordingly based on [semantic versioning guidelines](https://semver.org/) -## Commenting your code +### Commenting your code I am aware that perhaps I over-comment my code. That being said, I would much prefer that you over-comment than not comment at all. Comments can always be removed in minification if we ever decide to add that. They same cannot be said about the opposite. @@ -26,7 +37,7 @@ I believe that in collaboration, comments are essential. I do not expect every single line of code to be commented of course. Simple comments explaining general functionality of blocks of code will be sufficient. -## Variable, Function and Class naming +### Variable, Function and Class naming - **variables**: should follow the [snake_case](https://en.wikipedia.org/wiki/Snake_case) naming convention and generally be nouns - **functions**: should follow the [camelCase](https://en.wikipedia.org/wiki/Camel_case) naming convention and generally be verbs