Skip to content

docs(readme): add small subsection in README for reporting issues#125

Merged
Neclow merged 6 commits intosbhattlab:mainfrom
Neclow:joss120
Sep 29, 2025
Merged

docs(readme): add small subsection in README for reporting issues#125
Neclow merged 6 commits intosbhattlab:mainfrom
Neclow:joss120

Conversation

@Neclow
Copy link
Collaborator

@Neclow Neclow commented Sep 29, 2025

Add a short paragraph detailing guidelines for reporting issues or bugs directly in the README, as recommended by #111 and #120.

Fixes #120

openjournals/joss-reviews#9040

@Neclow Neclow requested a review from Copilot September 29, 2025 08:23
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a small subsection to the README with guidelines for reporting issues and bugs, addressing community feedback from issues #111 and #120. The changes make it easier for users to understand how to report problems or request features.

  • Expanded the "How to Contribute" section with clearer guidance on reporting issues and feature requests
  • Added direct links to the Issues and Pull Requests pages for easier navigation
  • Improved the overall user experience for community engagement

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Neclow and others added 2 commits September 29, 2025 10:25
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Neclow Neclow requested a review from Copilot September 29, 2025 08:25
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@Neclow Neclow requested a review from Copilot September 29, 2025 08:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@Neclow Neclow merged commit c65ea23 into sbhattlab:main Sep 29, 2025
8 checks passed
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.

[JOSS Review] guideline for reporting issues and seek support

2 participants