Skip to content

Add CONTRIBUTING.md file#94

Open
baranwalayush wants to merge 5 commits into
draeger-lab:masterfrom
baranwalayush:master
Open

Add CONTRIBUTING.md file#94
baranwalayush wants to merge 5 commits into
draeger-lab:masterfrom
baranwalayush:master

Conversation

@baranwalayush
Copy link
Copy Markdown
Collaborator

  • Added the CONTRIBUTING.md file to better help the new contributors and adhere to the standard coding guidelines.

Copy link
Copy Markdown
Member

@draeger draeger left a comment

Choose a reason for hiding this comment

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

I left a few suggestions for improvement. Thanks for preparing that!

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
@tyzerrr
Copy link
Copy Markdown
Contributor

tyzerrr commented Sep 24, 2025

@baranwalayush Basically, LGTM.
But maybe, this file is a little bit huge size.
CONTRINUTING.md is an entry point for new contributors, so this file should be shortened as much as possible.
This repo, official golang github repo is a great example for you.

@NeumannArthur
Copy link
Copy Markdown
Collaborator

LGTM

@tyzerrr tyzerrr requested a review from draeger September 27, 2025 02:38
@baranwalayush
Copy link
Copy Markdown
Collaborator Author

@tyzerrr Thank you for the suggestion! In the case of Golang, they have a separate webpage for contribution guidelines where they are redirecting from the contributing.md page, which is not true in our case. Besides that, I believe that there is nothing overwhelming in this file and a new contributor can easily read and understand the guidelines.

Copy link
Copy Markdown
Member

@draeger draeger left a comment

Choose a reason for hiding this comment

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

Thanks for this contribution!

@draeger draeger self-requested a review March 26, 2026 14:06
@baranwalayush
Copy link
Copy Markdown
Collaborator Author

Hi @draeger, I have updated this PR to include the steps for running SBML Test Runner, as discussed in #107.

@draeger draeger self-requested a review April 24, 2026 15:40
@Schmoho Schmoho requested review from Copilot and removed request for tyzerrr May 30, 2026 15:41
Copy link
Copy Markdown

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

Adds a new CONTRIBUTING.md to onboard contributors, expands the SBML Test Runner setup section in INSTALL.md, switches the README "For developers" section to "For Contributors" with a link to the new file, and makes two small code adjustments: switching the default test-runner wrapper script back to the non-LSODA wrapper class, and replacing the JUnit fail(...) call in SEDMLExample with a RuntimeException (also fixing the "Simulatation" typo).

Changes:

  • New CONTRIBUTING.md covering bug reports, enhancement requests, code contribution workflow, and links to INSTALL.md for setup.
  • Rewrites the SBML Test Runner section of INSTALL.md into numbered steps and updates README.md to point to CONTRIBUTING.md and list it in the project structure.
  • Updates sbml_test_suite_runner_wrapper.sh to invoke SBMLTestSuiteRunnerWrapper (non-LSODA) and replaces the JUnit fail(...) in SEDMLExample.java with a RuntimeException to remove the test-scope dependency from a main-source example.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
CONTRIBUTING.md New contributor guide with bug, enhancement, code contribution, setup, and help sections.
INSTALL.md Expanded SBML Test Runner setup into numbered, structured steps.
README.md Renames "For developers" to "For Contributors", links CONTRIBUTING.md, and updates the package structure listing.
src/test/scripts/sbml_test_suite_runner_wrapper.sh Switches wrapper target from SBMLTestSuiteRunnerWrapper_LSODA to SBMLTestSuiteRunnerWrapper.
src/main/java/org/simulator/examples/SEDMLExample.java Removes JUnit fail import and throws RuntimeException on simulation failure; fixes "Simulatation" typo.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread INSTALL.md
Comment on lines +71 to +74
- Results are displayed directly in the GUI:
- **Green** → Test passed
- **Red** → Test failed
- **Black** → Error during execution
Comment thread INSTALL.md
Comment on lines +84 to +87
- These can be used for:
- Manual verification
- Debugging discrepancies
- Custom analysis pipelines
Comment thread CONTRIBUTING.md
If you have questions or need assistance, please feel free to:

* Open an issue on our [Issue Tracker](https://github.com/draeger-lab/SBSCL/issues).
* Or you may ask to any maintainer.
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.

5 participants