Skip to content

Commit 83d320f

Browse files
mtfishmanmtfishman
committed
Package setup
0 parents  commit 83d320f

32 files changed

+820
-0
lines changed

‎.JuliaFormatter.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# See https://domluna.github.io/JuliaFormatter.jl/stable/ for a list of options
2+
style = "blue"
3+
indent = 2

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: ITensorDocsNext.jl bug report
3+
about: Create a bug report to help us improve ITensorDocsNext.jl
4+
title: "[BUG] YOUR SHORT DESCRIPTION OF THE BUG HERE"
5+
labels: ["bug"]
6+
assignees: ''
7+
8+
---
9+
10+
**Description of bug**
11+
12+
Please give a brief description of the bug or unexpected behavior here.
13+
14+
**Minimal code demonstrating the bug or unexpected behavior**
15+
16+
If applicable, provide a minimal code that can be run to demonstrate the bug or unexpected behavior.
17+
18+
If you are unable to construct a minimal code that demonstrates the bug or unexpected behavior, provide detailed steps for how to reproduce the behavior you are seeing.
19+
20+
<details><summary>Minimal runnable code</summary><p>
21+
22+
```julia
23+
[YOUR MINIMAL RUNNABLE CODE HERE]
24+
```
25+
26+
</p></details>
27+
28+
29+
**Expected output or behavior**
30+
31+
Describe what you expected to happen.
32+
33+
If you provided a minimal code that can be run to demonstrate the bug or unexpected behavior, describe what you expected the output would be.
34+
35+
36+
**Actual output or behavior**
37+
38+
Describe what actually happened.
39+
40+
If you provided a minimal code that demonstrates the bug or unexpected behavior, provide the output you get from that code. If the code leads to an error or warning, include the full error or warning below.
41+
42+
<details><summary>Output of minimal runnable code</summary><p>
43+
44+
```julia
45+
[OUTPUT OF YOUR MINIMAL RUNNABLE CODE HERE]
46+
```
47+
48+
</p></details>
49+
50+
51+
**Version information**
52+
53+
- Output from `versioninfo()`:
54+
```julia
55+
julia> versioninfo()
56+
[YOUR OUTPUT HERE]
57+
```
58+
- Output from `using Pkg; Pkg.status("ITensorDocsNext")`:
59+
```julia
60+
julia> using Pkg; Pkg.status("ITensorDocsNext")
61+
[YOUR OUTPUT HERE]
62+
```

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

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

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed (if applicable). Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes #(issue)
6+
7+
If practical and applicable, please include a minimal demonstration of the previous behavior and new behavior below.
8+
9+
<details><summary>Minimal demonstration of previous behavior</summary><p>
10+
11+
```julia
12+
[YOUR MINIMAL DEMONSTRATION OF PREVIOUS BEHAVIOR]
13+
```
14+
15+
</p></details>
16+
17+
<details><summary>Minimal demonstration of new behavior</summary><p>
18+
19+
```julia
20+
[YOUR MINIMAL DEMONSTRATION OF NEW BEHAVIOR]
21+
```
22+
23+
</p></details>
24+
25+
# How Has This Been Tested?
26+
27+
Please add tests that verify your changes to a file in the `test` directory.
28+
29+
Please give a summary of the tests that you added to verify your changes.
30+
31+
- [ ] Test A
32+
- [ ] Test B
33+
34+
# Checklist:
35+
36+
- [ ] My code follows the style guidelines of this project. Please run `using JuliaFormatter; format(".")` in the base directory of the repository (`~/.julia/dev/ITensorDocsNext`) to format your code according to our style guidelines.
37+
- [ ] I have performed a self-review of my own code.
38+
- [ ] I have commented my code, particularly in hard-to-understand areas.
39+
- [ ] I have added tests that verify the behavior of the changes I made.
40+
- [ ] I have made corresponding changes to the documentation.
41+
- [ ] My changes generate no new warnings.
42+
- [ ] Any dependent changes have been merged and published in downstream modules.

‎.github/dependabot.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
2+
version: 2
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/" # Location of package manifests
6+
schedule:
7+
interval: "weekly"

‎.github/workflows/CompatHelper.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: "CompatHelper"
2+
3+
on:
4+
schedule:
5+
- cron: 0 0 * * *
6+
workflow_dispatch:
7+
permissions:
8+
contents: write
9+
pull-requests: write
10+
11+
jobs:
12+
compat-helper:
13+
name: "CompatHelper"
14+
uses: "ITensor/ITensorActions/.github/workflows/CompatHelper.yml@main"
15+
with:
16+
localregistry: "https://github.com/ITensor/ITensorRegistry.git"

‎.github/workflows/Documentation.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "Documentation"
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
tags: '*'
8+
pull_request:
9+
schedule:
10+
- cron: '1 4 * * 4'
11+
12+
concurrency:
13+
group: ${{ github.workflow }}-${{ github.ref }}
14+
cancel-in-progress: ${{ github.ref_name != github.event.repository.default_branch || github.ref != 'refs/tags/v*' }}
15+
16+
jobs:
17+
build-and-deploy-docs:
18+
name: "Documentation"
19+
uses: "ITensor/ITensorActions/.github/workflows/Documentation.yml@main"
20+
with:
21+
localregistry: https://github.com/ITensor/ITensorRegistry.git
22+
secrets:
23+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

‎.github/workflows/FormatCheck.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: "Format Check"
2+
3+
on:
4+
push:
5+
branches:
6+
- 'main'
7+
tags: '*'
8+
pull_request:
9+
10+
jobs:
11+
format-check:
12+
name: "Format Check"
13+
uses: "ITensor/ITensorActions/.github/workflows/FormatCheck.yml@main"

‎.github/workflows/IntegrationTestRequest.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: "Integration Test Request"
2+
3+
on:
4+
issue_comment:
5+
types: [created]
6+
7+
jobs:
8+
integrationrequest:
9+
if: |
10+
github.event.issue.pull_request &&
11+
contains(fromJSON('["OWNER", "COLLABORATOR", "MEMBER"]'), github.event.comment.author_association)
12+
uses: ITensor/ITensorActions/.github/workflows/IntegrationTestRequest.yml@main
13+
with:
14+
localregistry: https://github.com/ITensor/ITensorRegistry.git

‎.github/workflows/LiterateCheck.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: "Literate Check"
2+
3+
on:
4+
push:
5+
branches:
6+
- 'main'
7+
tags: '*'
8+
pull_request:
9+
10+
jobs:
11+
literate:
12+
name: "Literate Check"
13+
uses: "ITensor/ITensorActions/.github/workflows/LiterateCheck.yml@main"
14+
with:
15+
localregistry: https://github.com/ITensor/ITensorRegistry.git

0 commit comments

Comments
 (0)