Skip to content

Commit 5b7d994

Browse files
colevandersWandscolevandersWands
committed
initial
0 parents  commit 5b7d994

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1175
-0
lines changed

‎.github/ISSUE_TEMPLATE/help_wanted.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: help wanted
3+
about: >
4+
A template issue for when you're blocked on certain lines of code.
5+
This template has many sections to get you thinking about your problem,
6+
you don't need to fill all of them.
7+
labels: "help wanted"
8+
---
9+
10+
<!--
11+
Make your issue easy to find:
12+
13+
- labels: anything that will make this easier to filter
14+
- assign: anyone you would like help from
15+
-->
16+
17+
## The Code
18+
19+
<!--
20+
The code you have a question about (it doesn't need to be your code!). This can
21+
be shared a few ways:
22+
23+
- a snippet in the MD of your issue or
24+
- a
25+
[permalink](https://help.github.com/en/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet)
26+
or
27+
- a [gist](https://help.github.com/en/github/writing-on-github/creating-gists)
28+
-->
29+
30+
## Best Understanding
31+
32+
<!--
33+
Explain the situation:
34+
35+
- What _does_ the code do
36+
- What do you _want_ it to do
37+
- How do you think it works?
38+
- What don't you understand about how it works?
39+
-->
40+
41+
## Best Efforts
42+
43+
<!--
44+
If this is your code and it has a bug, explain what you've tried so far:
45+
46+
- Include code
47+
- Mention everything you tried, even if it seems silly to you
48+
- What happened with each effort?
49+
- What brought you closer?
50+
- What brought you farther?
51+
-->
52+
53+
## Helpful Links
54+
55+
<!--
56+
Videos, articles, snippets, ... anything that helped you understand or make
57+
progress on the problem.
58+
-->
59+
60+
## Hopeful Links
61+
62+
<!--
63+
Links that look like they should be helpful but you just can't put all the
64+
pieces together.
65+
-->

‎.github/ISSUE_TEMPLATE/meeting_agenda.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: meeting agenda
3+
about: A template issue for planning meetings
4+
title: "Agenda: \_\_"
5+
labels: agenda
6+
---
7+
8+
9+
<!-- Make your issue easy to find:
10+
11+
- milestone: any milestones you will be addressing
12+
- tag: tag any issues you will be discussing (#issue-number)
13+
- labels: anything that will make this easier to filter
14+
- assign: anyone responsible for organizing or leading the meeting
15+
16+
-->
17+
18+
<!-- meeting overview -->
19+
20+
<!-- agenda points -->
21+
22+
- [ ] item 1
23+
- description
24+
- [ ] item 2
25+
- description
26+
- [ ] ...

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: question
3+
about: >
4+
A template issue for topics you'd like to discuss or learn more about.
5+
specific topics, general knowledge, it does not even need to be about code.
6+
There are no bad questions!
7+
labels: question
8+
---
9+
10+
<!--
11+
Make your issue easy to find:
12+
13+
- labels: anything that will make this easier to filter
14+
- assign: anyone you would like help from
15+
-->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: General PR template
3+
about: A template with a generic and high-level review checklist, feel free to modify the checklists based on your PR.
4+
---
5+
6+
<!--
7+
make this PR easy to find:
8+
9+
- assign and add reviewers
10+
- add any helpful labels
11+
- connect it to a milestone (if necessary)
12+
- link it with an issue (if necessary)
13+
-->
14+
15+
<!-- A clear and concise description of what the Pull Request is about. -->
16+
17+
## General Checks
18+
19+
- [ ] the branch is up to date with `main`
20+
- [ ] the code works when pulled and run locally
21+
- [ ] All CI checks pass (or at least discussed)
22+
- [ ] all conflicts are resolved (if any)
23+
- [ ] PR has a descriptive title
24+
- [ ] PR has appropriate labels and milestones for easy identification
25+
- [ ] PR it is assigned to the owner
26+
- [ ] reviewers are assigned
27+
- [ ] the PR contributes only one focused change
28+
- [ ] It is in the appropriate column in the project board (if necessary)
29+
- [ ] has short and clear description
30+
- [ ] is linked to an issue (if it is related)
31+
- [ ] feedback is addressed (if any and if it is appropriate feedback.)
32+
33+
## Markdown
34+
35+
<!-- markdown-specific checks -->
36+
37+
- [ ] the markdown source is formatted
38+
- [ ] spelling and grammar is correct in all text
39+
- [ ] The markdown looks correct when you preview the file
40+
- [ ] all links and images work

‎.github/workflows/ci-checks.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: ET CI Checks
2+
3+
on: [push, pull_request, workflow_dispatch]
4+
5+
jobs:
6+
ls_linting:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
- uses: ls-lint/action@v2.2.3
11+
12+
md_formatting:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: nosborn/github-action-markdown-cli@v3.3.0
17+
with:
18+
files: .
19+
config_file: .markdownlint.yml
20+
21+
py_formatting:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: actions/checkout@v4
25+
- name: Python - Check Formatting
26+
uses: astral-sh/ruff-action@v1
27+
with:
28+
args: "format --check"
29+
30+
py_linting:
31+
runs-on: ubuntu-latest
32+
steps:
33+
- uses: actions/checkout@v4
34+
35+
# passing ruff linting is required
36+
- name: Python - Check Linting - ruff
37+
uses: astral-sh/ruff-action@v1
38+
39+
# passing pylint is not required - discuss errors in code review
40+
# adapted from https://github.com/davidslusser/actions_python_pylint/tree/main
41+
- name: python version
42+
run: python --version
43+
shell: bash
44+
if: always()
45+
- name: install pylint
46+
run: |
47+
python - m pip install --upgrade pip
48+
pip install pylint
49+
shell: bash
50+
- name: Python - Check Linting - pylint
51+
run: "pylint solutions tests || echo '::warning title=Pylint Error(s)::Discuss solutions and trade-offs in code review.'"
52+
shell: bash
53+
54+
py_tests:
55+
runs-on: ubuntu-latest
56+
steps:
57+
- uses: actions/checkout@v4
58+
59+
- name: python version
60+
run: python --version
61+
shell: bash
62+
63+
- name: Check for test files
64+
id: check_tests
65+
run: |
66+
test_files=$(find ./solutions/tests -type f -name "test_*.py")
67+
if [ -n "$test_files" ]; then
68+
echo "Found test files:"
69+
echo "$test_files"
70+
echo "has_tests=true" >> $GITHUB_OUTPUT
71+
else
72+
echo "No test files found matching pattern ./solutions/tests/test_*.py"
73+
echo "has_tests=false" >> $GITHUB_OUTPUT
74+
fi
75+
shell: bash
76+
77+
- name: Python - Run Tests
78+
if: steps.check_tests.outputs.has_tests == 'true'
79+
run: python -m unittest
80+
shell: bash

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
__pycache__
2+
*.pytest_cache
3+
venv/
4+
# .env
5+
*.db
6+
*.idea
7+
*.ruff_cache

‎.ls-lint.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
ls:
2+
.dir: snake_case
3+
.*: snake_case
4+
.md: snake_case | regex:[0-9A-Z\-]+
5+
.txt: snake_case | kebab-case
6+
.yml: snake_case | kebab-case
7+
8+
ignore:
9+
- .git
10+
- .github
11+
- .vscode
12+
- venv
13+
- .ruff_cache
14+
- .pytest_cache
15+
- __pycache__
16+
- .ls-lint.yml
17+
- .markdownlint.yml

‎.markdownlint.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
ignore:
2+
- venv
3+
- .github

‎.vscode/extensions.json‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{
2+
"recommendations": [
3+
// For Pair Programming
4+
"MS-vsliveshare.vsliveshare",
5+
6+
// For Git & GitHub
7+
"mhutchie.git-graph",
8+
"eamodio.gitlens",
9+
"GitHub.vscode-pull-request-github",
10+
"donjayamanne.githistory",
11+
12+
// For programming generally
13+
"streetsidesoftware.code-spell-checker",
14+
"leodevbro.blockman",
15+
"alefragnani.project-manager",
16+
"vscode-icons-team.vscode-icons",
17+
"alefragnani.bookmarks",
18+
"visualstudioexptteam.vscodeintellicode",
19+
"aaron-bond.better-comments",
20+
"christian-kohler.path-intellisense",
21+
"usernamehw.errorlens",
22+
"tamasfe.even-better-toml",
23+
24+
// For writing Markdown
25+
"DavidAnson.vscode-markdownlint",
26+
"yzhang.markdown-all-in-one",
27+
"bierner.markdown-preview-github-styles",
28+
29+
// For writing Python
30+
"ms-python.python",
31+
"ms-python.vscode-pylance",
32+
"KevinRose.vsc-python-indent",
33+
"njpwerner.autodocstring",
34+
"LittleFoxTeam.vscode-python-test-adapter",
35+
"ms-python.black-formatter",
36+
"charliermarsh.ruff",
37+
"ms-python.pylint",
38+
"oderwat.indent-rainbow",
39+
"ms-python.debugpy",
40+
"frhtylcn.pythonsnippets",
41+
42+
// For writing Notebooks
43+
"ms-toolsai.jupyter",
44+
"ms-toolsai.jupyter-keymap",
45+
46+
// For working with data
47+
"RandomFractalsInc.vscode-data-preview",
48+
"mechatroner.rainbow-csv",
49+
"mtxr.sqltools"
50+
]
51+
}

‎.vscode/launch.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "ET: Debug Python (unittest)",
9+
"type": "debugpy",
10+
"request": "launch",
11+
"program": "-m",
12+
"args": ["unittest", "${file}"],
13+
"console": "integratedTerminal",
14+
"justMyCode": true
15+
}
16+
]
17+
}

0 commit comments

Comments
 (0)