Merge pull request #76 from logzio/ci/sync-templates

Sync templates

.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,55 @@
+name: Bug report
+description: Create a report to help us improve
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! Please make sure to fill out the entire form below, providing as much context as you can in order to help us triage and track down your bug as quickly as possible.
+  - type: textarea
+    attributes:
+      label: What happened?
+      description: Please provide as much detail as you reasonably can.
+      value: |
+        ## Description
+
+        ## Expected Result
+
+        ## Actual Result
+
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: How can we reproduce it?
+      description: Please provide steps to reproduce the issue.
+      value: |
+        1. 
+        2. 
+        3. 
+        4. 
+
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Environment information
+      description: Please provide any additional information about your installation, and version you are using.
+      value: |
+        ## Environment
+        OS: (e.g., "Ubuntu 20.04")
+        Compiler(if manually compiled): (e.g., "go 14.2")
+        Version: (e.g., "v1.0.0")
+
+  - type: textarea
+    attributes:
+      label: Log output
+      description: |
+        Please copy and paste any relevant log output.
+      render: shell
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Any additional information you think may be relevant to this issue.

.github/ISSUE_TEMPLATE/documentation.yaml

@@ -0,0 +1,22 @@
+name: Documentation issue
+description: Report an issue with the documentation
+labels: ["documentation"]
+body:
+  - type: textarea
+    attributes:
+      label: Describe the documentation issue
+      description: A clear description of what the issue is, including what part of the documentation is affected.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Suggested Fix
+      description: If possible, suggest how we can fix this documentation issue.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the documentation issue here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature.yaml

@@ -0,0 +1,24 @@
+name: Feature request
+description: Suggest an idea for this project
+labels: ["enhancement"]
+body:
+  - type: textarea
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.yaml

@@ -0,0 +1,16 @@
+name: Question
+description: Ask a question about the project
+labels: ["question"]
+body:
+  - type: textarea
+    attributes:
+      label: Describe your question
+      description: A clear and concise description of what the question is.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the question here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/security.yaml

@@ -0,0 +1,13 @@
+name: Security issue
+description: Report a security issue
+body:
+  - type: textarea
+    attributes:
+      label: Describe the security issue
+      description: A clear description of what the security issue is, including what version of the project is affected, and the vounerabile dependency.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,23 @@
+## Description 
+
+<!-- 
+    "This PR [adds/removes/fixes/replaces] the [feature/bug/etc].."
+    Do not leave this blank.
+    If relevant, describe the previous behaviour compared to the behaviour post your code change.
+-->
+
+## What type of PR is this?
+#### (check all applicable)
+- [ ] 🍕 Feature 
+- [ ] 🐛 Bug Fix
+- [ ] 🧑‍💻 Code Refactor
+- [ ] 🔥 Performance Improvements
+- [ ] ✅ Test
+- [ ] 🤖 Build / CI
+- [ ] ⏩ Revert
+
+## Added tests?
+
+- [ ] 👍 yes
+- [ ] 🙅 no, because they aren't needed
+- [ ] 🙋 no, because I need help from somebody

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing guide
+
+First of all, thank you for taking the time to contribute! 💛
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them.  
+Please make sure to read the relevant section before making your contribution.
+
+## Table of Contents
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+  - [Reporting Bugs](#reporting-bugs)
+  - [Suggesting Enhancements](#suggesting-enhancements)
+  - [Code Contributions](#code-contributions)
+  - [Improving The Documentation](#improving-the-documentation)
+
+## I Have a Question
+> [!IMPORTANT]
+> If you want to ask a question, please take a moment to review the available [Documentation](../../).
+
+For the quickest assistance, please contact the Logz.io Support team using the chat icon located in the bottom-right corner of your Logz.io account.
+
+If you prefer, you can [open an issue on GitHub](../../issues/), and our team will get back to you as soon as possible.
+
+
+## I Want To Contribute
+Reporting bugs and submitting feature requests are important contributions.
+
+### Reporting Bugs
+> [!NOTE]
+> **Before reporting a bug**, please ensure you are using the latest version.
+
+**When reporting a bug**, please ensure you include the below information:
+* Current behavior (issue description)
+* Expected behavior
+* Steps to reproduce
+
+You can either reach out to Logz.io Support team using the chat icon located in the bottom-right corner of your Logz.io account.
+
+Or if you prefer, you can [open an issue on GitHub](../../issues/), and our team will address it as soon as possible.
+
+### Suggesting Enhancements
+You can either reach out to Logz.io Support team using the chat icon located in the bottom-right corner of your Logz.io account.
+
+Or if you prefer, you can [open an issue on GitHub](../../issues/), and our team will address it as soon as possible.
+
+
+### Code Contributions
+1. Checkout a new branch following the naming convention: `bugfix/<issue>` or `feature/<name>`.
+2. Make your changes.
+3. Test your changes locally.
+4. Push your changes and open a new PR.
+
+### Improving The Documentation.
+You can either:
+1. Reach out to Logz.io Support team using the chat icon located in the bottom-right corner of your Logz.io account.
+2. [Open an issue on GitHub](../../issues/), and our team will address it as soon as possible.
+3. Open a PR with the needed changes.
+   - Checkout a new branch following the naming convention: `doc/<topic>`.
+   - Make your changes.
+   -  Push your changes and open a new PR.
+
+## Attribution.
+This guide is based on the **contributing-gen** ❤️ [Make your own](https://github.com/bttger/contributing-gen)!