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

Update Readme.md #132

Merged
merged 1 commit into from
Sep 6, 2024
Merged

Update Readme.md #132

merged 1 commit into from
Sep 6, 2024

Conversation

Satarupa22-SD
Copy link
Contributor

@Satarupa22-SD Satarupa22-SD commented Sep 6, 2024

update contribution guidelines.

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
  • Bug fix
  • Feature implementation
  • Doc updates
  • Related Issue

#114

  • What changes have you introduced?
    update contributing guidelines

  • Does this PR introduce a breaking change?
    No

update contribution guidelines.
Copy link

sourcery-ai bot commented Sep 6, 2024

Reviewer's Guide by Sourcery

This pull request updates the Readme.md file in the collaborate directory to provide more comprehensive contribution guidelines for the PSLab project. The changes focus on expanding the existing content and adding new sections to guide potential contributors through various aspects of the contribution process.

File-Level Changes

Change Details Files
Expanded and restructured the contribution guidelines
  • Added a welcome message and introduction to the PSLab project
  • Expanded the section on creating experiments
  • Added information about file formats (Markdown and reStructuredText)
  • Included a section on recommended editing tools
  • Added detailed instructions for reporting bugs
  • Included guidelines for suggesting enhancements
  • Added a section on making first code contributions
  • Expanded the pull request guidelines
  • Added a section on the submission process for contributions
collaborate/Readme.md

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • 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

@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 @Satarupa22-SD - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider reorganizing the content for better flow and readability. The current structure jumps between topics and could be more logically ordered.
  • Ensure consistency in the information about tools. The mention of notex seems out of place and could be integrated into the 'Editing Tools' section or removed.
  • Review the removed content from the original README to ensure no valuable information was lost in the update.
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: 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 to tell me if it was helpful.

@orangecms orangecms enabled auto-merge (squash) September 6, 2024 17:02
@orangecms orangecms merged commit 44d60dd into fossasia:master Sep 6, 2024
1 check passed
@orangecms
Copy link
Collaborator

Sorry, no idea what this annoying bot is about.
I don't agree with it.

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