Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

maint: Tech review #9

Merged
merged 39 commits into from
Aug 12, 2024
Merged

maint: Tech review #9

merged 39 commits into from
Aug 12, 2024

Conversation

AlejandroFernandezLuces
Copy link
Contributor

@AlejandroFernandezLuces AlejandroFernandezLuces commented Aug 5, 2024

  • Write some examples. Example in readme is enough
  • Unit tests are missing fixed in testing: add unit testing #11
  • Require workflows passing before merging PRs
  • Workflows for tests and docs.
  • Set up github pages
  • Docs are missing.
  • Set documentation link in description.
  • License is missing.
  • License headers?
  • Convert to pyproject
  • Add installable script, since this is an application.
  • Add contributing guide.
  • Rename folders to more descriptive names.
  • Add smoke tests.
  • Add labeler.
  • Add project URLs to TOML
  • Check if repository configuration is compliant with PyAnsys requirements
  • Add module docstrings.
  • Use ruff.

@AlejandroFernandezLuces AlejandroFernandezLuces marked this pull request as ready for review August 6, 2024 09:52
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall good review - thanks @AlejandroFernandezLuces - please solve my comments

.github/labeler.yml Outdated Show resolved Hide resolved
.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
.github/workflows/ci_cd.yml Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
src/allie/flowkit/__init__.py Outdated Show resolved Hide resolved
src/allie/flowkit/fastapi_utils.py Show resolved Hide resolved
src/allie/flowkit/fastapi_utils.py Outdated Show resolved Hide resolved
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 2 minor comments

.github/workflows/ci_cd.yml Outdated Show resolved Hide resolved
doc/source/index.rst Outdated Show resolved Hide resolved
@AlejandroFernandezLuces
Copy link
Contributor Author

@laurasgkadri98 Review is ready from our side, feel free to take a look and if everything is fine for you, and then we can merge 🙂

Copy link
Contributor

@laurasgkadri98 laurasgkadri98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Alex, couple coments:

  • Dockerfile not working.
  • README.md outdated due to recent changes.

@wiz-inc-572fc38784
Copy link

Wiz Scan Summary

IaC Misconfigurations 0C 0H 0M 2L 0I
Vulnerabilities 0C 0H 0M 0L 0I
Sensitive Data 0C 0H 0M 0L 0I
Total 0C 0H 0M 2L 0I
Secrets 0🔑

@AlejandroFernandezLuces AlejandroFernandezLuces merged commit 8e43620 into main Aug 12, 2024
22 checks passed
@AlejandroFernandezLuces AlejandroFernandezLuces deleted the maint/tech-review branch August 12, 2024 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants