Merge pull request #33 from yoannchb-pro/dev

v1.1.0

.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier'
+  ],
+  ignorePatterns: ['node_modules/'],
+  overrides: [
+    {
+      files: ['extension/popup/*.js', 'src/**/*.ts'],
+      rules: {}
+    }
+  ]
+};

.githooks/pre-commit

@@ -0,0 +1,3 @@
+#!/bin/bash
+npm run prettier
+npm run lint

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,28 @@
+## Bug Report
+
+**Description of the Bug**
+A clear and concise description of the bug.
+
+**Steps to Reproduce**
+
+1. Step 1
+2. Step 2
+3. ...
+
+**Expected Behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual Behavior**
+A clear and concise description of what actually happens.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Tried Solutions**
+Have you tried anything to solve the problem? If yes, what?
+
+**Additional Context**
+Add any other context about the problem here.
+
+**Additional Information**
+Add any other information you think is relevant.

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,16 @@
+## Feature Request
+
+**Description of the Feature**
+A clear and concise description of the feature you'd like to see added.
+
+**Motivation**
+An explanation of the motivation behind this feature. How would it improve the user experience or utility of the software?
+
+**Screenshot (Optional)**
+If possible, add a screenshot or illustration of the feature you're proposing.
+
+**Additional Context**
+Add any other context or information about the feature that you think is relevant.
+
+**Additional Information**
+Add any other information you think is relevant.

.github/ISSUE_TEMPLATE/HELP_REQUEST.md

@@ -0,0 +1,24 @@
+## Help Request
+
+**Issue Summary**
+
+[Summarize the issue you are facing concisely.]
+
+**Describe the problem**
+
+[Describe what is the problem]
+
+**Environment**
+
+- Operating System: [Your OS]
+- Browser: [Your Browser]
+- Version: [Version Number]
+- Any other relevant information
+
+### Screenshots
+
+[Include any relevant screenshots if they can help illustrate the issue.]
+
+### Additional Information
+
+[Any additional information that may be helpful in diagnosing the issue.]

.github/pull_request_template.md

@@ -0,0 +1,28 @@
+## Pull Request
+
+**Description**
+A brief description of the changes in this pull request.
+
+**Related Issue**
+
+- Fixes # (issue number)
+- Addresses # (issue number)
+
+**Changes Made**
+Describe the changes you've made. Provide a high-level overview of what has been done in this pull request.
+
+**Screenshots (if applicable)**
+Add screenshots or GIFs to demonstrate the changes, if applicable.
+
+**Checklist**
+
+- [ ] I have tested the changes locally.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added necessary comments to the code.
+- [ ] All tests pass successfully.
+
+**Additional Notes**
+Add any additional notes or comments about the pull request here.
+
+**Reviewer(s)**
+@username1, @username2

.prettierrc

@@ -0,0 +1,10 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "useTabs": false,
+  "printWidth": 100,
+  "trailingComma": "none",
+  "arrowParens": "avoid",
+  "endOfLine": "auto"
+}

CHANGELOG.md

@@ -1,24 +1,37 @@
-# CHANGELOG
-
-## v1.0.3
-
-- Removed the option `table formating` because it will now set to true by default
-- Adjusted the abort timeout to 15seconds
-- If an error occur the user can now click back on the question
-- `Textbox, question to answser mode and clipboard mode` is not formatted anymore
-- Fixed many bugs
-- Write AI system instructions
-
-## v1.0.2
-
-- Added `mode`
-
-## v1.0.1
-
-- Removed langage
-- Added a button next to model to get the last ChatGPT version
-- Added update message
-
-## v1.0.0
-
-- Initial commit
+# CHANGELOG
+
+## v1.1.0
+
+- Bugs correction
+- Adjusted the abort timeout to 20seconds
+- `code` is not required anymore
+- Issue [#9](https://github.com/yoannchb-pro/MoodleGPT/issues/9) resolved
+- GPT model autocompletation
+- Better algorithm to find the correct answer (levenshtein distance)
+- Better ChatGPT prompt
+- Added `history` to the options/configuration
+- Added `include images` to the option/configuration
+- `gpt-4` support
+
+## v1.0.3
+
+- Removed the option `table formating` because it will now set to true by default
+- Adjusted the abort timeout to 15seconds
+- If an error occur the user can now click back on the question
+- `Textbox, question to answser mode and clipboard mode` is not formatted anymore
+- Fixed many bugs
+- Write AI system instructions
+
+## v1.0.2
+
+- Added `mode`
+
+## v1.0.1
+
+- Removed langage
+- Added a button next to model to get the last ChatGPT version
+- Added update message
+
+## v1.0.0
+
+- Initial commit

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTE.md

@@ -0,0 +1,43 @@
+# CONTRIBUTE
+
+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.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Code of Conduct
+
+See the code of conduct [here](./CODE_OF_CONDUCT.md)
+
+## Pull Request Process
+
+1. Update the README.md with details of changes to the extension and update the screens.
+2. Build the project.
+3. Select `dev` as the target branch to prepare the futur version.
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Setup the project
+
+```
+node: 18.13.0
+npm: 8.19.2
+```
+
+### 1. Install dependencies
+
+```
+$ npm install
+```
+
+### 2. Setup Git hooks
+
+```
+$ git config --local core.hooksPath .githooks/
+```
+
+### 3. Build project
+
+```
+$ npm run build
+```