Skip to content

Commit 86d4836

Browse files
committed
Add GitHub issue templates for bug reports, feature requests, and doc changes
1 parent 736e91e commit 86d4836

11 files changed

Lines changed: 243 additions & 3 deletions

File tree

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# All files in the repository must be reviewed by one of these users
2+
* @Alomir @dlebauer @mdietze @mswilburn
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
### Bug Description
8+
9+
A clear and concise description of what the bug is.
10+
11+
In the format "When I do X, I expect Y but observe Z"
12+
13+
### To Reproduce
14+
15+
Steps to reproduce the behavior:
16+
1. Go to '...'
17+
2. Click on '....'
18+
3. Scroll down to '....'
19+
4. See error
20+
21+
## Expected behavior
22+
23+
A clear and concise description of what you expected to happen.
24+
25+
## Screenshots
26+
27+
If applicable, add screenshots to help explain your problem.
28+
29+
## SIPNET Version
30+
31+
- Version or Git SHA [e.g. 2.1.0 or abc1234]
32+
33+
## Additional context
34+
35+
Add any other context about the problem here.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Documentation Changes
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
### Document Change needed
8+
9+
A clear description of what changes are needed with the location of the error, or that needs to be fixed.
10+
11+
Example:
12+
There is a broken URL link in the documentation. It is in the parameters documentation. The underlying file is `docs/parameters.md`. The correct link should be https://aws.amazon.com/.
13+
14+
### Information for those wanting to make changes
15+
16+
Please refer to the documentation guidelines in `CONTRIBUTING.md` to learn how to make changes to the documentation.
17+
18+
All markdown files related to documentation are located within the main directory `docs/`.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
## Description
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
## Use Cases and Requirements
13+
14+
**Describe the use cases and requirements**
15+
Please focus on describing the problem and your requirements without going into the solution space. We believe in understanding requirements before design, and design before solution!
16+
17+
## Alternatives Considered (Optional)
18+
19+
**Describe alternatives you've considered**
20+
A clear and concise description of any alternative workflows or workarounds you are currently using.
21+
22+
## Additional Context
23+
24+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!-- Please fill out the sections below to help reviewers. -->
2+
3+
## Summary
4+
5+
- **What**: Short description of the functional or documentation changes
6+
- **Motivation**: Why is this change needed?
7+
8+
## How was this change tested?
9+
List steps taken to test this change, with appropriate outputs if applicable
10+
11+
If changes are needed for any `sipnet.out` files in the `test/smoke` subdirectories, then include output from
12+
`tools/smoke_check.py` by running the commands below and pasting the output at the end of this PR. Note that
13+
this must be run BEFORE submitting changes to any `sipnet.out` files.
14+
```bash
15+
make smoke
16+
python tools/smoke_check.py run verbose <list tests/smoke subdirectories with changed outputs>
17+
```
18+
Run `python tools/smoke_check.py help` for more info.
19+
20+
## Reproduction steps
21+
22+
If appropriate, list steps to reproduce the change locally
23+
24+
## Related issues
25+
26+
- Fixes #<issue>
27+
28+
## Checklist
29+
30+
- [ ] Related issues are listed above. [PRs without an approved, related issue may not get reviewed](docs/CONTRIBUTING.md#propose-and-receive-feedback).
31+
- [ ] PR title has the issue number in it ("[#<number>] \<concise description of proposed change>")
32+
- [ ] Tests added/updated for new features (if applicable)
33+
- [ ] Documentation updated (if applicable)
34+
- [ ] `docs/CHANGELOG.md` updated with noteworthy changes
35+
- [ ] Code formatted with `clang-format` (run `git clang-format` if needed)
36+
37+
---
38+
39+
**Note**: See [CONTRIBUTING.md](../docs/CONTRIBUTING.md) for additional guidance. This repository uses automated formatting checks; if the pre-commit hook blocks your commit, run `git clang-format` to format staged changes.

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77
pull_request:
88

99
jobs:
10+
1011
# Build and Integration Test
1112
build:
1213
strategy:

.github/workflows/cpp-linter.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ jobs:
2626
- name: analysis
2727
if: steps.linter.outputs.checks-failed > 0
2828
run: |
29-
echo "${{ steps.linter.outputs.checks-failed }} linter checks failed" |
30-
29+
echo "${{ steps.linter.outputs.checks-failed }} linter checks failed"
30+
exit 1

.github/workflows/debug.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Setup Linux Debug Session
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
debug_enabled:
7+
type: boolean
8+
description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
9+
required: false
10+
default: false
11+
12+
jobs:
13+
# Debug environment
14+
debug:
15+
runs-on: ubuntu-latest
16+
environment: debug
17+
steps:
18+
- uses: actions/checkout@v4
19+
- name: Install gdb
20+
if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
21+
run: sudo apt install gdb
22+
- name: Setup tmate session
23+
if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
24+
uses: mxschmitt/action-tmate@v3

.github/workflows/docs-build.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Build and Upload Docs
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
types: [opened, synchronize, reopened, closed]
9+
10+
permissions:
11+
contents: read # needed for checkout
12+
pages: write # to deploy to GitHub Pages
13+
id-token: write # to authenticate with GitHub Pages
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: true
18+
19+
jobs:
20+
build:
21+
name: docs-build
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Install system deps
28+
run: |
29+
sudo apt-get update
30+
sudo apt-get install -y doxygen graphviz
31+
python3 -m pip install --upgrade pip
32+
python3 -m pip install mkdocs mkdocs-material pymdown-extensions
33+
34+
- name: Build docs (MkDocs + Doxygen)
35+
run: |
36+
make clean document
37+
touch site/.nojekyll
38+
39+
- name: Upload Pages artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: site

.github/workflows/docs-publish.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Publish Docs
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: "pages-prod"
14+
cancel-in-progress: true
15+
16+
jobs:
17+
build:
18+
name: docs-build
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Install system deps
25+
run: |
26+
sudo apt-get update
27+
sudo apt-get install -y doxygen graphviz
28+
python3 -m pip install --upgrade pip
29+
python3 -m pip install mkdocs mkdocs-material pymdown-extensions
30+
31+
- name: Build docs (MkDocs + Doxygen)
32+
run: |
33+
make clean document
34+
touch site/.nojekyll
35+
36+
- name: Upload Pages artifact
37+
uses: actions/upload-pages-artifact@v3
38+
with:
39+
path: site
40+
41+
deploy:
42+
name: deploy-pages
43+
needs: build
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
runs-on: ubuntu-latest
48+
permissions:
49+
pages: write
50+
id-token: write
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)