docs: add contributor guidelines related docs

rootCircle · Feb 9, 2024 · 3424703 · 3424703
1 parent cfecdf8
commit 3424703
Show file tree

Hide file tree

Showing 12 changed files with 735 additions and 143 deletions.
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml
@@ -0,0 +1,80 @@
+name: "🐛 Bug Report"
+description: Create a new ticket for a bug.
+title: "🐛 [BUG] - <title>"
+labels: [
+  "bug"
+]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: Please enter an explicit description of your issue
+      placeholder: Short and explicit description of your incident...
+    validations:
+      required: true
+  - type: input
+    id: reprod-url
+    attributes:
+      label: "Reproduction URL"
+      description: Please enter your GitHub URL to provide a reproduction of the issue
+      placeholder: ex. https://github.com/USERNAME/docFiller
+    validations:
+      required: true
+  - type: textarea
+    id: reprod
+    attributes:
+      label: "Reproduction steps"
+      description: Please enter an explicit description of your issue
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+      render: bash
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots"
+      description: If applicable, add screenshots to help explain your problem.
+      value: |
+        ![DESCRIPTION](LINK.png)
+      render: bash
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: "Logs"
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: bash
+    validations:
+      required: false
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: "Browsers"
+      description: What browsers are you seeing the problem on ?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+        - Opera
+    validations:
+      required: false
+  - type: dropdown
+    id: os
+    attributes:
+      label: "OS"
+      description: What is the impacted environment ?
+      multiple: true
+      options:
+        - Windows
+        - Linux
+        - Mac
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
@@ -0,0 +1,55 @@
+name: "💡 Feature Request"
+description: Create a new ticket for a new feature request
+title: "💡 [REQUEST] - <title>"
+labels: [
+  "question"
+]
+body:
+ - type: textarea
+    id: implementation_pr
+    attributes:
+      label: "Implementation PR"
+      description: Pull request used
+      placeholder: "#Pull Request ID"
+    validations:
+      required: false
+  - type: textarea
+    id: reference_issues
+    attributes:
+      label: "Reference Issues"
+      description: Common issues
+      placeholder: "#Issues IDs"
+    validations:
+      required: false
+  - type: textarea
+    id: summary
+    attributes:
+      label: "Summary"
+      description: Provide a brief explanation of the feature
+      placeholder: Describe in a few lines your feature request
+    validations:
+      required: true
+  - type: textarea
+    id: basic_example
+    attributes:
+      label: "Basic Example"
+      description: Indicate here some basic examples of your feature.
+      placeholder: A few specific words about your feature request.
+    validations:
+      required: true
+  - type: textarea
+    id: drawbacks
+    attributes:
+      label: "Drawbacks"
+      description: What are the drawbacks/impacts of your feature request ?
+      placeholder: Identify the drawbacks and impacts while being neutral on your feature request
+    validations:
+      required: true
+  - type: textarea
+    id: unresolved_question
+    attributes:
+      label: "Unresolved questions"
+      description: What questions still remain unresolved ?
+      placeholder: Identify any unresolved issues.
+    validations:
+      required: false
diff --git a/.github/PULL_REQUEST_TEMPLATE/DEFAULT.md b/.github/PULL_REQUEST_TEMPLATE/DEFAULT.md
@@ -0,0 +1,19 @@
+## Proposed Changes
+
+<!-- Please provide a brief description of the changes introduced by this pull request. -->
+
+## Related Issue
+
+<!-- Please link to the related issue(s) this pull request addresses. -->
+
+Fixes # (issue number)
+
+## Checklist
+
+<!-- Please check off the following items if they apply to this pull request. -->
+
+- [ ] I have tested my changes thoroughly.
+- [ ] I have updated the documentation accordingly.
+- [ ] My code follows the project's coding conventions and style.
+- [ ] I have added necessary comments to my code, particularly in complex areas.
+- [ ] I have ensured that my changes do not introduce any new issues.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1 @@
+# Changelog
diff --git a/README.md b/README.md
@@ -1,79 +1,56 @@
-## 🚀 Web Extension README
+# 🚀 docFiller
 
 [![Discord](https://img.shields.io/discord/1129752670287184022?logo=discord)](https://discord.gg/aExAhPd64X)
 
-Automated Google Docs Filling Web Extension written in JS. The extension is built using manifest v2 and currently supports the following browsers: Mozilla Firefox, Google Chrome, and Microsoft Edge.
+> The extension is built using manifest v2 and currently supports the following browsers: Mozilla Firefox only.
 
-## Installation Instructions
+Automated Google Docs Filling Web Extension written in JS. Filling boring google form done easy! 
 
-### Mozilla Firefox 🔥
+## Project Overview
 
-1. Download the extension package.
-2. Open Mozilla Firefox and navigate to about:debugging.
-3. Click on the "This Firefox" button in the upper right corner of the screen.
-4. Select "Load Temporary Add-on..." from the dropdown menu.
-5. Navigate to the folder where you downloaded the extension package and select the manifest.json file.
-6. You should now see the extension added to the list of installed extensions.
+### Features
+- **Automated Google Docs Filling**: Fill Google Docs forms automatically with predefined data using AI.
+- **Cross-Browser Compatibility**: Supports major browsers including Mozilla Firefox, Google Chrome, and Microsoft Edge.
+- **Customizable**: Easily configurable to adapt to different use cases and requirements.
 
-### Google Chrome 🌐
+### How It Works
+The Web Extension simplifies the process of filling Google Docs forms by automating repetitive tasks. Users can configure the extension with predefined data and settings, allowing them to quickly populate Google Docs without manual input.
 
-1. Download the extension package.
-2. Open Google Chrome and navigate to chrome://extensions.
-3. Enable Developer Mode by toggling the switch in the upper right corner of the screen.
-4. Click on the "Load unpacked" button in the upper left corner of the screen.
-5. Navigate to the folder where you downloaded the extension package and select it.
-6. You should now see the extension added to the list of installed extensions.
+### Use Cases
+- **Form Filling**: Ideal for individuals or organizations that frequently fill out standardized forms or templates in Google Docs.
+- **Data Entry Automation**: Streamline data entry processes by automating the input of common information into Google Docs.
 
-### Microsoft Edge 🌊
+## Installation
 
-1. Download the extension package.
-2. Open Microsoft Edge and navigate to edge://extensions/.
-3. Enable Developer Mode by toggling the switch in the lower left corner of the screen.
-4. Click on the "Load unpacked" button in the lower left corner of the screen.
-5. Navigate to the folder where you downloaded the extension package and select it.
-6. You should now see the extension added to the list of installed extensions.
+For detailed installation instructions, please refer to the [INSTALL.md](docs/INSTALL.md) file.
 
-## Usage Instructions 📖
+## Usage
 
-Once the extension is installed, you can start using it immediately. Simply click on the extension icon in your browser toolbar to access its features. The specific functionality of the extension will depend on its purpose, so please refer to its documentation for more information.
+Once the extension is installed, you can start using it immediately. Simply click on the extension icon in your browser toolbar to access its features. For usage instructions and additional details, please refer to the [documentation](docs).
 
-## Contributing 🤝
+## Contributing
 
-Contributions are always welcome! If you would like to contribute to the development of this web extension, please follow these steps:
+We welcome contributions! If you would like to contribute to the development of this web extension, please follow the guidelines outlined in the [CONTRIBUTING.md](docs/CONTRIBUTING.md) file.
 
-1. Fork the repository to your own GitHub account.
-2. Clone the forked repository to your local machine.
-3. Make the changes you want in your local copy of the repository.
-4. Test your changes to make sure they work as expected.
-5. Submit a pull request to the original repository and explain the changes you made.
+## Security
 
-I would recommend `web-ext` for development in Firefox, it significantly decrease development times. Devs can install it using `npm install --global web-ext`.
+For information about our security policy, please refer to the [SECURITY.md](docs/SECURITY.md) file.
 
-## Development
+## Support
 
-1. Make sure you use `yarn` and not `npm` while installing the packages
-2. Webpack is configured for the project
-3. Do not edit the manifest.json, webpack.config.js files
-4. Clone the repo
-5. Run `yarn` in the terminal to install the required dependencies
-6. Run `yarn dev` to test the extension. A new firefox window will open with the extension loaded.
+For support, bug reports, and feature requests, please refer to the [SUPPORT.md](docs/SUPPORT.md) file.
 
-## License:
+## Governance
 
-This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0).
+To understand the governance model and decision-making processes for our project, please refer to the [GOVERNANCE.md](docs/GOVERNANCE.md) file.
 
-Under this license, you are free to:
+## Roadmap
 
-- Share: copy and redistribute the material in any medium or format
-- Adapt: remix, transform, and build upon the material
+For our project roadmap, please refer to the [roadmap.pdf](docs/roadmap.pdf) file.
 
-Under the following terms:
+## License
 
-- Attribution: You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
-- NonCommercial: You may not use the material for commercial purposes.
-- ShareAlike: If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
-
-For more details, please refer to the full license text at https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.
+This project is licensed under the [GNU GPL 3.0)](LICENSE).
 
 ## Resources 🔍
 
@@ -86,7 +63,7 @@ For more details, please refer to the full license text at https://creativecommo
 
 ## ✨ Contributors
 
-<a href="https://github.com/rootCircle/symmetrical-octo-spork/graphs/contributors">
-  <img alt="Grid of profile icons of the contributors" src="https://contrib.rocks/image?repo=rootCircle/symmetrical-octo-spork" />
+<a href="https://github.com/rootCircle/docFiller/graphs/contributors">
+  <img alt="Grid of profile icons of the contributors" src="https://contrib.rocks/image?repo=rootCircle/docFiller" />
 </a>
 <!--  https://contrib.rocks -->