Merge pull request #1 from harshit-budhraja/main

chore: added readme, security policy and issue templates

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,61 @@
+name: Bug report
+description: Create a report to help us improve!
+title: '[Bug]: '
+labels:
+  - bug
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        This repository is for reporting bugs with the ImageKit DAM app, which we respond to on a best-effort basis.
+  - type: input
+    id: version
+    attributes:
+      label: App Version
+      description: >-
+        Right click on the app icon in the system tray and select "About" to get
+        the version number
+      placeholder: 1.0.0
+    validations:
+      required: true
+  - type: input
+    id: platform
+    attributes:
+      label: Platform
+      description: >-
+        The platform you're using the app on. Please include the chipset for Mac
+        devices.
+      placeholder: E.g. "Windows 11" or "MacOS Sonoma 14.4.1 - Apple M1 Chip"
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Please give a clear and concise description of the bug
+    validations:
+      required: true
+  - type: textarea
+    id: repro
+    attributes:
+      label: Reproduce
+      description: Steps to reproduce the bug
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behaviour
+      description: What is the expected behavior?
+      placeholder: >-
+        E.g. "It should open the profile page on ImageKit Dashboard in my
+        browser"
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Info
+      description: >-
+        Additional info you want to provide such as logs, system info,
+        environment, etc.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: "ImageKit Documentation"
+    about: "Get the help you need to start managing your digital assets using the app."
+    url: "https://imagekit.io/docs/dam/app"

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels:
+  - enhancement
+assignees: ''
+
+---
+
+**Tell us about your request**
+A clear and concise description of what you want to happen or the change you would like to see
+
+**Tell us about the problem you're trying to solve. What are you trying to do, and why is it hard?**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Are you currently working around the issue?**
+A clear and concise description of any alternative solutions or features you've considered or are using today.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.md

@@ -1 +1,22 @@
-# ImageKit Desktop
+## ImageKit Desktop
+
+ImageKit's desktop application for quick access to Digital Asset Management (DAM) on Mac and Windows.
+
+### Download
+
+ImageKit DAM app for Mac and Windows is free to [download](https://github.com/imagekit-developer/imagekit-desktop/releases/latest).
+
+### Documentation
+
+For more details about ImageKit DAM app and the features it offers, please refer to our [documentation](https://imagekit.io/docs/dam/app).
+
+### Support
+
+Bugs with the app can be filed as issues in this ([imagekit-developer/imagekit-desktop](https://github.com/imagekit-developer/imagekit-desktop/)) repository, which we respond to
+on a best-effort basis.
+
+### This Repository
+
+This repository contains an issue tracker for the ImageKit DAM app. If you experience a problem with the app, you can [browse the existing issues](https://github.com/imagekit-developer/imagekit-desktop/issues) or search from the bar at the top (`s` to focus) and, if you don't find an existing issue similar to yours, [open a new issue](https://github.com/imagekit-developer/imagekit-desktop/issues/new).
+
+**© ImageKit Private Limited 2024**

security.md

@@ -0,0 +1,15 @@
+# Security Policy
+
+### Supported Versions
+
+The following versions of the ImageKit DAM app are currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| >= 1.x   | :white_check_mark: |
+
+### Reporting a Vulnerability
+
+Please **DO NOT** file a public issue, instead send your report privately to [email protected]
+
+Security reports are greatly appreciated and we will publicly thank you for it, although we will keep your name confidential if you request it. We also like to send gifts—if you're into swag, make sure to let us know. We currently do not offer a paid security bug bounty program, but are not ruling it out in the future.