Add CONTRIBUTING.md file#94
Conversation
draeger
left a comment
There was a problem hiding this comment.
I left a few suggestions for improvement. Thanks for preparing that!
|
@baranwalayush Basically, LGTM. |
|
LGTM |
|
@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. |
draeger
left a comment
There was a problem hiding this comment.
Thanks for this contribution!
There was a problem hiding this comment.
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.mdcovering bug reports, enhancement requests, code contribution workflow, and links toINSTALL.mdfor setup. - Rewrites the SBML Test Runner section of
INSTALL.mdinto numbered steps and updatesREADME.mdto point toCONTRIBUTING.mdand list it in the project structure. - Updates
sbml_test_suite_runner_wrapper.shto invokeSBMLTestSuiteRunnerWrapper(non-LSODA) and replaces the JUnitfail(...)inSEDMLExample.javawith aRuntimeExceptionto 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.
| - Results are displayed directly in the GUI: | ||
| - **Green** → Test passed | ||
| - **Red** → Test failed | ||
| - **Black** → Error during execution |
| - These can be used for: | ||
| - Manual verification | ||
| - Debugging discrepancies | ||
| - Custom analysis pipelines |
| 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. |
CONTRIBUTING.mdfile to better help the new contributors and adhere to the standard coding guidelines.