Skip to content
This repository has been archived by the owner on Aug 8, 2024. It is now read-only.

Commit

Permalink
πŸ“¦οΈ NEW: Strongapp data now importable (#3)
Browse files Browse the repository at this point in the history
* πŸ“– DOC: make file comments
* πŸ‘Œ IMPROVE: change deploy to version
* πŸ› FIX: docker build will only work off release branch
* Revert "πŸ‘Œ IMPROVE: change deploy to version"
This reverts commit 487564e.
* πŸ“¦ NEW: add pre-commit and other configs
* ❗️ BREAKING: remove the common directory in favor of submodule
* πŸ“¦ NEW: added common submodule
* πŸ‘Œ IMPROVE: add cmd for submodule updating
* πŸ“– DOC: working on updating readme
* πŸ§ͺ️ TEST: test code coverage action
* πŸ› FIX: put python function back to 3.9
* πŸ§ͺ️ TEST: change way poetry is installed
* πŸ§ͺ️ TEST: correct poetry install cmd
* πŸ› FIX: add pytest-cov dependency
* πŸ§ͺ️ TEST: finished testing workflow test
* πŸ“– DOC: change README
* πŸ› FIX: fix doc issues from linter
* πŸ› FIX: appease the allmighty linter
  • Loading branch information
tallguyjenks authored May 9, 2023
1 parent 87b72a0 commit 0bcc494
Show file tree
Hide file tree
Showing 40 changed files with 1,439 additions and 95 deletions.
23 changes: 23 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[flake8]
max-line-length = 88
max-complexity = 18
exclude =
.git,
__pycache__,
build,
dist,
reports
select = B,C,E,F,W,T4,B9
ignore =
E203,
E266,
E501,
W503,
F401,
F403
# E203: whitespace before β€˜:’
# E266: too many leading β€˜#’ for block comment
# E501: line too long (82 > 79 characters)
# W503: line break before binary operator
# F401: module imported but unused
# F403: β€˜from module import *’ used; unable to detect undefined names
7 changes: 7 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
######################################################################

# These owners will be the default owners for everything in the repo #

######################################################################

- @<GH USERNAME> @github-actions
8 changes: 8 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# These are supported funding model platforms
github: <GH USERAME>
patreon: bryanjenks # FIXME change this if you have a patreon
custom:
[
"https://www.buymeacoffee.com/<GH USERAME>",
"https://www.paypal.me/<GH USERAME>",
]
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: πŸ›οΈ Bug Report
description: File a bug report
title: "πŸ›οΈ: "
labels: ["bug"]
assignees:
- <GH USERNAME>
body:
- type: markdown
attributes:
value: |
> Thanks for taking the time to fill out this bug report!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Please provide a clear and concise description of what the bug is and what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of our software are you running?
# FIXME need to put a list of the released version here
options:
- 0.0.1
- 0.0.2
- 0.0.3
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell-script
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- type: checkboxes
id: agreements
attributes:
label: Agreements
description: By submitting this issue, you agree that you have provided and performed the following
options:
- label: I have provided the necessary information about my bug report
required: true
- label: I have downloaded the latest version of this repo and reproduced my issue with the latest version
required: true
- label: If I have posted the same issue elsewhere, I have also mentioned it in this issue.
required: true
- label: I understand that my issue may be closed if I don't fulfill my promises.
required: true
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCUMENTATION.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: πŸ“–οΈ Documentation
description: File an issue regarding documentation
title: "πŸ“–οΈ: "
labels: ["documentation"]
assignees:
- <GH USERNAME>
body:
- type: markdown
attributes:
value: |
> Thanks for taking the time to help us improve our documentation!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: checkboxes
id: type-of-change
attributes:
label: What type of documentation change?
description: Let us know what type of change to the repo documentation this issues is regarding
options:
- label: There is missing documentation where there should be something (pick at least 1)
required: false
- label: There's a typo
required: false
- label: Something is incorrect
required: false
- label: Suggestion on documentation improvement
required: false
- label: Something should be removed
required: false
- label: Other?
required: false
- type: textarea
id: description
attributes:
label: Describe The Change
description: Please provide a clear and concise description of what the requested change is?
placeholder: Thank you for your contribution!
value: "Let us know!"
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- type: checkboxes
id: agreements
attributes:
label: Agreements
description: By submitting this issue, you agree that you have provided and performed the following
options:
- label: I have provided the necessary information about my bug report
required: true
- label: I have downloaded the latest version of this repo and reproduced my issue with the latest version
required: true
- label: If I have posted the same issue elsewhere, I have also mentioned it in this issue.
required: true
- label: I understand that my issue may be closed if I don't fulfill my promises.
required: true
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: πŸ“¦ Feature Request
description: Request A Feature
title: "πŸ“¦: "
labels: ["enhancement"]
assignees:
- <GH USERNAME>
body:
- type: markdown
attributes:
value: |
> Thanks for taking the time to help us improve!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
id: related-to-problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
placeholder: Thank you for helping us improve!
value: "Please describe"
validations:
required: true
- type: textarea
id: requested-solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: Thank you for helping us improve!
value: "Please describe"
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
placeholder: Thank you for helping us improve!
value: "Please describe"
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: Thank you for helping us improve!
value: "Please describe"
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- type: checkboxes
id: agreements
attributes:
label: Agreements
description: By submitting this issue, you agree that you have provided and performed the following
options:
- label: I have provided the necessary information about my bug report
required: true
- label: I have downloaded the latest version of this repo and reproduced my issue with the latest version
required: true
- label: If I have posted the same issue elsewhere, I have also mentioned it in this issue.
required: true
- label: I understand that my issue may be closed if I don't fulfill my promises.
required: true
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: ❓️ Question
description: Ask a general question about how to use the project
title: "❓️: "
labels: ["question"]
assignees:
- <GH USERNAME>
body:
- type: markdown
attributes:
value: |
> Thanks for your interest in this project!
- type: textarea
id: description
attributes:
label: What is your question?
description: Please provide a clear and concise description of your question?
placeholder: Thank you for your interest!
value: "❓❓❓"
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true
- type: checkboxes
id: agreements
attributes:
label: Agreements
description: By submitting this issue, you agree that you have provided and performed the following
options:
- label: I have provided the necessary information about my bug report
required: true
- label: I have downloaded the latest version of this repo and reproduced my issue with the latest version
required: true
- label: If I have posted the same issue elsewhere, I have also mentioned it in this issue.
required: true
- label: I understand that my issue may be closed if I don't fulfill my promises.
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: πŸ™πŸ» Support This Project
url: https://github.com/sponsors/<GH USERNAME>
about: Help support continued development on this project
- name: πŸ‘¨πŸ»β€πŸ’» More about the maintainer
url: <WEBSITE>
about: get to know the maintainer of <REPO NAME>
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Pull request

Create a pull request to help us improve. See [CONTRIBUTING](/CONTRIBUTING.md).

---

## Confirmations

---

- [ ] I have communicated my intent to create this pull request via repo [Discussions](https://github.com/<REPO NAME>/discussions) or [Issues](https://github.com/<REPO NAME>/issues) before undertaking this work
- [ ] I have read [CONTRIBUTING](/CONTRIBUTING.md)
- [ ] My commits are granular and descriptive
- [ ] I have used [Emoji Log](https://github.com/ahmadawais/Emoji-Log) for my commit messages and pull request title
- [ ] My pull request body references the issue it is for, ex: `resolves #11`
- [ ] My pull request passes all checks
- [ ] I acknowledge that if I have not satisfied all of these requirements my pull request **MAY** be closed at maintainers discretion

---

## Relevant Information About This Pull Request

---

My Info Here

---
25 changes: 25 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
open-pull-requests-limit: 10
commit-message:
prefix: "πŸ€–οΈ GH Actions "
include: "scope"
labels: [ "dependencies" ]
reviewers: [ "<GH USERAME>" ]

# Maintain dependencies for python with poetry
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "daily"
open-pull-requests-limit: 10
commit-message:
prefix: "πŸ€–οΈ MAIN: "
prefix-development: "πŸ€–οΈ DEV: "
include: "scope"
labels: [ "dependencies" ]
reviewers: [ "<GH USERAME>" ]
1 change: 1 addition & 0 deletions .github/linters/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
**/.vscode/*.json
3 changes: 3 additions & 0 deletions .github/linters/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"ignorePatterns": "**/.vscode/*.json"
}
22 changes: 22 additions & 0 deletions .github/linters/.flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[flake8]
max-line-length = 88
max-complexity = 18
exclude =
.git,
__pycache__,
build,
dist
select = B,C,E,F,W,T4,B9
ignore =
E203,
E266,
E501,
W503,
F401,
F403
# E203: whitespace before β€˜:’
# E266: too many leading β€˜#’ for block comment
# E501: line too long (82 > 79 characters)
# W503: line break before binary operator
# F401: module imported but unused
# F403: β€˜from module import *’ used; unable to detect undefined names
Loading

0 comments on commit 0bcc494

Please sign in to comment.