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

chore: add readme #96

Merged
merged 7 commits into from
Dec 20, 2024
Merged

chore: add readme #96

merged 7 commits into from
Dec 20, 2024

Conversation

JaeAeich
Copy link
Contributor

@JaeAeich JaeAeich commented Dec 19, 2024

This PR is for README.

This PR was branched on top of last PR #95 which had some changes:

  • Pinned pip version because CI failed on resolving python deps and asked for a specific pip version range.
  • docker-compose has been depricated and docker compose comes as plugin ever since v3.
  • Added some type hints to resolve mypy errors.

Summary by Sourcery

Documentation:

  • Add a README file with information about the project, installation instructions, contribution guidelines, and contact information.

Copy link

sourcery-ai bot commented Dec 19, 2024

Reviewer's Guide by Sourcery

This pull request adds initial documentation for the proWES project, including a README, contribution guidelines, and basic project information. It also updates the CI to pin the pip version.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a comprehensive README file with details on proWES, including its purpose, features, and usage instructions.
  • Added a synopsis section.
  • Added a description section.
  • Added installation instructions.
  • Added contribution guidelines.
  • Added versioning information.
  • Added license information.
  • Added contact information.
  • Included badges for license, chat, and CI.
  • Added logos for GA4GH, ELIXIR, and ELIXIR Cloud & AAI.
README.md
Updated CI to pin pip version.
  • Pinned pip version to 24.0.x.
.github/workflows/main.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @JaeAeich - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@JaeAeich
Copy link
Contributor Author

@uniqueg Please ignore the commits from the previous PR, this PR is on top of it so the CI don't fail.

@JaeAeich JaeAeich requested a review from uniqueg December 19, 2024 14:50
@uniqueg
Copy link
Member

uniqueg commented Dec 19, 2024

Maybe amend the description to say why you pinned the Pip version. Also, you could mention that you added a type hint (presumably because Mypy complained), updated the Docker Compose call (as required by recent versions) and restricted the FOCA version.

@JaeAeich
Copy link
Contributor Author

@sourcery-ai review

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @JaeAeich - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@JaeAeich
Copy link
Contributor Author

Maybe amend the description to say why you pinned the Pip version. Also, you could mention that you added a type hint (presumably because Mypy complained), updated the Docker Compose call (as required by recent versions) and restricted the FOCA version.

Those were for the last PR (those files aren't here anymore) but still added them here too.

@JaeAeich JaeAeich requested a review from uniqueg December 19, 2024 17:47
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

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

Fixed a type, now LGTM :)

@JaeAeich JaeAeich merged commit 1e9ca97 into dev Dec 20, 2024
3 checks passed
@JaeAeich JaeAeich deleted the readme branch December 20, 2024 10:16
lvarin pushed a commit that referenced this pull request Jan 8, 2025
* minor changes

* pin pip version

* chore: add readme

* chore: review

* chore: review

* Update README.md

---------

Co-authored-by: Alex Kanitz <[email protected]>
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.

2 participants