Skip to content
This repository was archived by the owner on Feb 14, 2025. It is now read-only.

Commit 3418548

Browse files
joachimdalenjoachimdalen
authored
Add repo metafiles (#24)
1 parent 4122773 commit 3418548

File tree

5 files changed

+137
-0
lines changed

5 files changed

+137
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: "\U0001F41E Report a problem"
2+
description: "Report an issue with bicepdocs"
3+
title: (fill in)"
4+
labels:
5+
- "@type/bug"
6+
- "@status/needs-confirmation"
7+
body:
8+
- type: dropdown
9+
attributes:
10+
label: What formatter are you using?
11+
description: |
12+
Please keep in mind that some problems might be formatter specific
13+
options:
14+
- "Markdown"
15+
- "Docusaurus"
16+
validations:
17+
required: true
18+
- type: input
19+
attributes:
20+
label: Bicep version
21+
description: |
22+
What version of bicep are you using? (Run `bicep --version`.)
23+
placeholder: |
24+
e.g. v0.13.1
25+
validations:
26+
required: true
27+
- type: input
28+
attributes:
29+
label: Bicepdocs version
30+
description: |
31+
What version of bicepdocs are you using? (Run `bicepdocs --version`.)
32+
placeholder: |
33+
e.g. v0.1.0
34+
validations:
35+
required: true
36+
- type: dropdown
37+
attributes:
38+
label: What operating system are you using?
39+
description: |
40+
Please keep in mind that bicepdocs has OS specific binaries
41+
options:
42+
- "macOS"
43+
- "Linux"
44+
- "Windows"
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: What is the bug you want to report?
50+
description: |
51+
Please include a *minimal* reproduction case. In most cases the actual bicep template that fails will do. If you are unable to add the actual template, see if you can reproduce the issue with a template that can be shared. Some issue might be very hard to debug without the template that is causing the issues.
52+
value: |
53+
Provide a description of your bug here
54+
55+
```bicep
56+
<!-- Add the bicep template here. If the template is very large, please use a text pasting service like Github Gists -->
57+
```
58+
validations:
59+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🗣 Ask a question
4+
url: https://github.com/joachimdalen/bicepdocs/discussions
5+
about: Ask a question or get help with bicepdocs

‎.github/ISSUE_TEMPLATE/feature-request.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: "\U0001F4DD Request a new feature"
2+
description: "Request additional features that does not exist in bicepdocs today"
3+
title: "(fill in)"
4+
labels:
5+
- "@type/feature"
6+
body:
7+
- type: input
8+
attributes:
9+
label: Bicepdocs version
10+
description: |
11+
What version of bicepdocs are you using? (Run `bicepdocs --version`.)
12+
placeholder: |
13+
e.g. v0.1.0
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: What problem do you want to solve with this feature?
19+
description: |
20+
Please explain your use case. Add enough details for the change to make sense and why it should exist.
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: If you were to solve it, how would you do it?
26+
description: |
27+
Explain what you think is the best solution or implementation to your requested feature
28+
validations:
29+
required: true

‎.github/pull_request_template.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**What changes does this pull request introduce?**
2+
3+
Shortly describe your change...
4+
5+
**Is there anything specific the reviewers should keep in mind when reviewing this pull request?**
6+
7+
Fill inn..
8+
9+
[ ] I agree that by publishing this pull request I am submitting my own code that I have the rights to use and implement. I also assign full ownership of the code over to the `bicepdocs` maintainers under the MIT licenese.
10+
11+
**Please check the appropriate options:**
12+
13+
- [ ] I have read the [contributing guidelines](#).
14+
- [ ] I have updated the relevant documentation.
15+
- [ ] Latest version of `main` is merged into my branch.

‎CONTRIBUTING.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contribution guidelines
2+
3+
This document describes the contribution guidelines for bicepdocs.
4+
5+
## 💻 &nbsp; Branching
6+
7+
We try to use branch folders for different type of changes
8+
9+
- `feature/` - is used when adding a new feature or changing existing features
10+
- `bugfix/` - is used when fixing a bug
11+
- `docs/` - is used when only adding, updating or deleting documentation
12+
13+
## Pull Requests
14+
15+
All changes, no matter how small should go through pull requests.
16+
17+
## ✅ &nbsp; Versioning
18+
19+
Versioning of the tool is determined manually and the sources are tagged. The release process starts when the tag is created. All versions below `1.0.0` may contain breaking changes on minor and patch adjustments. While below `1.0.0` the tools is considered to be in beta.
20+
21+
### 🎯 &nbsp; Versioning standard
22+
23+
The tools is versioned and follows the [Semantic Versioning 2.0.0 standard](https://semver.org/spec/v2.0.0.html):
24+
25+
Given a version number MAJOR.MINOR.PATCH, increment the:
26+
27+
- MAJOR version when you make incompatible API changes to public APIs
28+
- MINOR version when you add functionality in a backwards compatible manner
29+
- PATCH version when you make backwards compatible bug fixes

0 commit comments

Comments
 (0)