Skip to content

Commit 5754410

Browse files
yotamloeyotamloe
authored
Merge pull request #39 from logzio/ci/sync-templates
Sync templates
2 parents d1494da + b08c49c commit 5754410

File tree

7 files changed

+216
-0
lines changed

7 files changed

+216
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yaml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
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.
9+
- type: textarea
10+
attributes:
11+
label: What happened?
12+
description: Please provide as much detail as you reasonably can.
13+
value: |
14+
## Description
15+
16+
## Expected Result
17+
18+
## Actual Result
19+
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
attributes:
25+
label: How can we reproduce it?
26+
description: Please provide steps to reproduce the issue.
27+
value: |
28+
1.
29+
2.
30+
3.
31+
4.
32+
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: Environment information
39+
description: Please provide any additional information about your installation, and version you are using.
40+
value: |
41+
## Environment
42+
OS: (e.g., "Ubuntu 20.04")
43+
Compiler(if manually compiled): (e.g., "go 14.2")
44+
Version: (e.g., "v1.0.0")
45+
46+
- type: textarea
47+
attributes:
48+
label: Log output
49+
description: |
50+
Please copy and paste any relevant log output.
51+
render: shell
52+
- type: textarea
53+
attributes:
54+
label: Additional context
55+
description: Any additional information you think may be relevant to this issue.

‎.github/ISSUE_TEMPLATE/documentation.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Documentation issue
2+
description: Report an issue with the documentation
3+
labels: ["documentation"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Describe the documentation issue
8+
description: A clear description of what the issue is, including what part of the documentation is affected.
9+
validations:
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: Suggested Fix
14+
description: If possible, suggest how we can fix this documentation issue.
15+
validations:
16+
required: false
17+
- type: textarea
18+
attributes:
19+
label: Additional context
20+
description: Add any other context or screenshots about the documentation issue here.
21+
validations:
22+
required: false

‎.github/ISSUE_TEMPLATE/feature.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Is your feature request related to a problem? Please describe.
8+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
validations:
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: Describe the solution you'd like
14+
description: A clear and concise description of what you want to happen.
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Describe alternatives you've considered
20+
description: A clear and concise description of any alternative solutions or features you've considered.
21+
- type: textarea
22+
attributes:
23+
label: Additional context
24+
description: Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Question
2+
description: Ask a question about the project
3+
labels: ["question"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Describe your question
8+
description: A clear and concise description of what the question is.
9+
validations:
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: Additional context
14+
description: Add any other context or screenshots about the question here.
15+
validations:
16+
required: false

‎.github/ISSUE_TEMPLATE/security.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Security issue
2+
description: Report a security issue
3+
body:
4+
- type: textarea
5+
attributes:
6+
label: Describe the security issue
7+
description: A clear description of what the security issue is, including what version of the project is affected, and the vounerabile dependency.
8+
validations:
9+
required: true
10+
- type: textarea
11+
attributes:
12+
label: Additional context
13+
description: Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Description
2+
3+
<!--
4+
"This PR [adds/removes/fixes/replaces] the [feature/bug/etc].."
5+
Do not leave this blank.
6+
If relevant, describe the previous behaviour compared to the behaviour post your code change.
7+
-->
8+
9+
## What type of PR is this?
10+
#### (check all applicable)
11+
- [ ] 🍕 Feature
12+
- [ ] 🐛 Bug Fix
13+
- [ ] 🧑‍💻 Code Refactor
14+
- [ ] 🔥 Performance Improvements
15+
- [ ] ✅ Test
16+
- [ ] 🤖 Build / CI
17+
- [ ] ⏩ Revert
18+
19+
## Added tests?
20+
21+
- [ ] 👍 yes
22+
- [ ] 🙅 no, because they aren't needed
23+
- [ ] 🙋 no, because I need help from somebody

‎CONTRIBUTING.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing guide
2+
3+
First of all, thank you for taking the time to contribute! 💛
4+
5+
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.
6+
Please make sure to read the relevant section before making your contribution.
7+
8+
## Table of Contents
9+
- [I Have a Question](#i-have-a-question)
10+
- [I Want To Contribute](#i-want-to-contribute)
11+
- [Reporting Bugs](#reporting-bugs)
12+
- [Suggesting Enhancements](#suggesting-enhancements)
13+
- [Code Contributions](#code-contributions)
14+
- [Improving The Documentation](#improving-the-documentation)
15+
16+
## I Have a Question
17+
> [!IMPORTANT]
18+
> If you want to ask a question, please take a moment to review the available [Documentation](../../).
19+
20+
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.
21+
22+
If you prefer, you can [open an issue on GitHub](../../issues/), and our team will get back to you as soon as possible.
23+
24+
25+
## I Want To Contribute
26+
Reporting bugs and submitting feature requests are important contributions.
27+
28+
### Reporting Bugs
29+
> [!NOTE]
30+
> **Before reporting a bug**, please ensure you are using the latest version.
31+
32+
**When reporting a bug**, please ensure you include the below information:
33+
* Current behavior (issue description)
34+
* Expected behavior
35+
* Steps to reproduce
36+
37+
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.
38+
39+
Or if you prefer, you can [open an issue on GitHub](../../issues/), and our team will address it as soon as possible.
40+
41+
### Suggesting Enhancements
42+
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.
43+
44+
Or if you prefer, you can [open an issue on GitHub](../../issues/), and our team will address it as soon as possible.
45+
46+
47+
### Code Contributions
48+
1. Checkout a new branch following the naming convention: `bugfix/<issue>` or `feature/<name>`.
49+
2. Make your changes.
50+
3. Test your changes locally.
51+
4. Push your changes and open a new PR.
52+
53+
### Improving The Documentation.
54+
You can either:
55+
1. Reach out to Logz.io Support team using the chat icon located in the bottom-right corner of your Logz.io account.
56+
2. [Open an issue on GitHub](../../issues/), and our team will address it as soon as possible.
57+
3. Open a PR with the needed changes.
58+
- Checkout a new branch following the naming convention: `doc/<topic>`.
59+
- Make your changes.
60+
- Push your changes and open a new PR.
61+
62+
## Attribution.
63+
This guide is based on the **contributing-gen** ❤️ [Make your own](https://github.com/bttger/contributing-gen)!

0 commit comments

Comments
 (0)