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

feat: add readme #2

Merged
merged 5 commits into from
Jun 29, 2024
Merged

feat: add readme #2

merged 5 commits into from
Jun 29, 2024

Conversation

psankhe28
Copy link
Collaborator

@psankhe28 psankhe28 commented Jun 29, 2024

Summary by Sourcery

This pull request introduces a new README.md file that provides detailed documentation for the project, including installation steps, usage instructions, and other relevant information for contributors and users.

  • Documentation:
    • Added a comprehensive README.md file detailing the project's purpose, installation instructions, running the application, contributing guidelines, code of conduct, versioning, license, and contact information.

Copy link
Contributor

sourcery-ai bot commented Jun 29, 2024

Reviewer's Guide by Sourcery

This pull request replaces the existing README.md content with a detailed README for the Crypt4GH Middleware for proTES project. The new README includes sections for synopsis, installation, running the application, contributing, code of conduct, versioning, license, and contact information. It also adds badges for license and chat.


Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@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 @psankhe28 - I've reviewed your changes and they look great!

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

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 to tell me if it was helpful.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
psankhe28 and others added 4 commits June 29, 2024 13:01
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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.

1 participant