Merge pull request #33 from oxen-io/issue_templates

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,120 @@
+name: 🐞 Bug Report
+description: Create a report to help us improve.
+title: "[Bug]: "
+labels: [ "bug" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search through [existing issues](https://github.com/oxen-io/websites/issues?q=sort%3Aupdated-desc+is%3Aissue+label%3Abug) to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Self-training on how to write a bug report
+      description: High quality bug report can help the team save time and improve the chance of getting fixed. Please read [how to write a bug report](https://www.browserstack.com/guide/how-to-write-a-bug-report) before submitting your issue.
+      options:
+        - label: I have learned [how to write a bug report](https://www.browserstack.com/guide/how-to-write-a-bug-report)
+          required: true
+  - type: checkboxes
+    attributes:
+      label: Code of conduct
+      description: I have read and agree to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
+      options:
+        - label: I have read and agree to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md)
+          required: true
+  - type: dropdown
+    id: project
+    attributes:
+      label: Project
+      description: What project does this relate to?
+      options:
+        - Staking Portal
+        - Other
+      default: 0
+    validations:
+      required: true
+  - type: dropdown
+    id: device
+    attributes:
+      label: Device Type
+      description: What device type are you seeing this issue on?
+      options:
+        - Desktop
+        - Mobile
+        - Tablet
+        - Other
+      default: 0
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Browser
+      description: What browser are you seeing this issue on?
+      placeholder: eg. Chrome 126
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Browser Resolution
+      description: What browser resolution does this issue occur on? You can find this easily using tools like https://mdigi.tools/browser-resolution/
+      placeholder: eg. 1280 x 795
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Operating System
+      description: What operating system are you seeing this issue on?
+      placeholder: eg. Fedora Linux 39
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: What wallet are you using and how are you connecting your wallet? (if applicable)
+      description: If your issue relates to any wallet functionality, please provide the wallet name and how you are connecting your wallet.
+      placeholder: eg. Metamask Browser Extension
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A concise description of what you're experiencing. Please include screenshots and recordings if applicable. See [how to record your screen](https://www.howtogeek.com/205742/how-to-record-your-windows-mac-linux-android-or-ios-screen/).
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. In this environment...
+        2. With this config...
+        3. Run '...'
+        4. See error...
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. See [how to save browser logs](https://support.shortpoint.com/support/solutions/articles/1000222881-save-browser-console-file).
+      render: shell
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+        
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: 💬 Session Token Discord
+    url: https://discord.com/invite/J5BTQdCfXN
+    about: Please ask and answer questions here.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,59 @@
+name: 🚀 Feature request
+description: Suggest an idea for a new feature
+title: '[Feature]: '
+labels: [ "enhancement" ]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing request for feature?
+      description: Please search to see if an issue already exists for the feature you are requesting.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: dropdown
+    id: project
+    attributes:
+      label: Project
+      description: What project does this relate to?
+      options:
+        - Staking Portal
+        - Other
+      default: 0
+    validations:
+      required: true
+  - type: dropdown
+    id: type
+    attributes:
+      label: Feature Request Type
+      description: What kind of feature request is this?
+      options:
+        - Solve a problem
+        - Add a new feature
+        - Improve an existing feature
+        - Other
+      default: 0
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Feature Motivation
+      description: |
+        A clear and concise description of the feature motivation. 
+        If you are suggesting a new feature, please explain why you think it should be added.
+      placeholder: Eg. I'm frustrated when [...] so I would like to see [...]
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Request Details
+      description: |
+        A clear and concise description of the feature and any details that would be helpful to implement it.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Add any other context or screenshots about the feature request here
+    validations:
+      required: false

CODE_OF_CONDUCT.md

@@ -0,0 +1,82 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone. We pledge to act and interact in ways that contribute to an open,
+welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.