Skip to content

Commit ef9f5a1

Browse files
authored
Feature/doc fixes for open source (#150)
* Added .idea to gitignore * PR feedback
1 parent 02a6727 commit ef9f5a1

File tree

5 files changed

+14
-24
lines changed

5 files changed

+14
-24
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,27 @@ assignees: ''
88
---
99

1010
**Version information**
11+
<!--
1112
- The version of DCE.
1213
- OS and version
1314
- Go version
1415
- Terraform version (if using directly)
16+
-->
1517

1618
**Describe the bug**
17-
A clear and concise description of what the bug is.
19+
<!-- A clear and concise description of what the bug is. -->
1820

1921
**To Reproduce**
22+
<!--
2023
Steps to reproduce the behavior:
2124
1. Go to '...'
2225
2. Click on '....'
2326
3. Scroll down to '....'
2427
4. See error
28+
-->
2529

2630
**Expected behavior**
27-
A clear and concise description of what you expected to happen.
31+
<!-- A clear and concise description of what you expected to happen. -->
2832

2933
**Additional context**
30-
Add any other context about the problem here.
34+
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ assignees: ''
88
---
99

1010
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1212

1313
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
14+
<!-- A clear and concise description of what you want to happen. -->
1515

1616
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1818

1919
**Additional context**
20-
Add any other context or screenshots about the feature request here.
20+
<!-- Add any other context or screenshots about the feature request here.-->

.github/pull_request_template.md

+1-16
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Describe the big picture of your changes here to communicate to the maintainers
99
## Types of changes
1010

1111
<!--
12-
What types of changes does your code introduce to the module?
12+
What types of changes does your code introduce to the repo?
1313
Put an `x` in the boxes that apply
1414
-->
1515

@@ -31,21 +31,6 @@ Put an `x` in the boxes that apply. You can also fill these out after creating t
3131
- [ ] I have updated the `CHANGELOG.md` under a `## next` release, with a short summary of my changes
3232

3333

34-
## Dependencies and Blockers
35-
36-
37-
38-
<!--
39-
40-
Is there anything preventing this PR from being merged and deployed to prod?
41-
42-
eg. other PRs that are required, external blockers, etc.
43-
44-
If so, this is a high-risk deployment, and we should call this out for manual attention
45-
46-
-->
47-
48-
4934
## Relevant Links
5035

5136
<!--

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ override.tf.json
6060

6161
# Other stuff
6262
*.zip
63+
.idea/
6364

6465
junit-report/
6566
test.output.txt

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ We have some general guidelines towards contributing to this project.
2020

2121
*Go*
2222

23-
The source code for this project is written in Go. You are welcome to add versions of files for other languages, however the core code will remain in Go.
23+
The Lambda and CodeBuild function code is written in Golang. We prefer that similar contributed code also be written in Golang. Please ensure your Golang code is formatted by [gofmt](https://golang.org/cmd/gofmt/) and linted by [golint](https://godoc.org/golang.org/x/lint).
2424

2525
## Pull Requests
2626

0 commit comments

Comments
 (0)