From ff9a7effda8f5419ee6f8e2b24b73c32422d118e Mon Sep 17 00:00:00 2001 From: baranwalayush Date: Tue, 23 Sep 2025 20:51:39 +0530 Subject: [PATCH 1/2] Add CONTRIBUTING.md and update README.md --- README.md | 7 +++++-- .../java/org/testsuite/SBMLTestSuiteRunnerWrapper.java | 3 +-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d071f7be..b670d868 100644 --- a/README.md +++ b/README.md @@ -51,8 +51,9 @@ Bio-Informatics, Libraries, Simulations ### For users For an introduction on how to use this library for simulation, please refer to the [UserGuidelines.md](UserGuidelines.md) file. There you can find explanations on how to simulate different models and code snippets, including the links to the complete code examples. -### For developers -To start working on SBSCL, you should first clone the repository and then refer to [INSTALL.md](INSTALL.md) which gives instruction to run maven build. Once a maven build is ran, the binaries will be generated in the target folder. This folder will also include a JAR files of the simulation core library to work with. +### For Contributors +New contributors can refer to [CONTRIBUTING.md](CONTRIBUTING.md) which gives instruction about the build process and contribution guidelines.
+You can also refer to [INSTALL.md](INSTALL.md) which gives instruction to run maven build. Once a maven build is ran, the binaries will be generated in the target folder. This folder will also include a JAR files of the simulation core library to work with. For an introduction on how things currently work in SBSCL to simulate different models, please refer to the sequence diagrams present in the [/dev/diagrams/](https://github.com/draeger-lab/SBSCL/tree/master/dev/diagrams/) where you can understand complete workflow of the library. Once you get familiarized with how things work, please open the javadoc [homepage](https://draeger-lab.github.io/SBSCL/apidocs/overview-summary.html) where you can find the complete information about the library properly documented. For formatting the code-base, please refer to [formatting-guidelines](https://github.com/draeger-lab/SBSCL/tree/master/dev/formatting-guidelines/). @@ -107,6 +108,8 @@ The package structure in more detail: |- test -> JUnit test files along with resources required |- site -> Contains markup files, old javadoc, site.xml and other website resources + |- CONTRIBUTING.md -> Contains the guidelines and instructions for new contributors + |- INSTALL.md -> Contains the instruction to run maven build |- LICENSE.txt -> the license, under which this project is distributed |- pom.xml -> Maven file for building the project |- README.md -> this file diff --git a/src/main/java/org/testsuite/SBMLTestSuiteRunnerWrapper.java b/src/main/java/org/testsuite/SBMLTestSuiteRunnerWrapper.java index 8d3da2ca..3ee4a59f 100644 --- a/src/main/java/org/testsuite/SBMLTestSuiteRunnerWrapper.java +++ b/src/main/java/org/testsuite/SBMLTestSuiteRunnerWrapper.java @@ -21,7 +21,6 @@ import org.sbml.jsbml.ext.fbc.FBCConstants; import org.sbml.jsbml.validator.ModelOverdeterminedException; import org.simulator.comp.CompSimulator; -import org.simulator.examples.CompExample; import org.simulator.fba.FluxBalanceAnalysis; import org.simulator.io.CSVImporter; import org.simulator.math.odes.AbstractDESSolver; @@ -60,7 +59,7 @@ public class SBMLTestSuiteRunnerWrapper { public static final String RELATIVE = "relative"; public static final String NAN = "NaN"; private static final double TOLERANCE_FACTOR = 1E-5; - private static final Logger LOGGER = Logger.getLogger(CompExample.class.getName()); + private static final Logger LOGGER = Logger.getLogger(SBMLTestSuiteRunnerWrapper.class.getName()); /** * The wrapper executes the simulation of a given SBML file and writes result to a specified CSV From 8aac51de6fa539ca98b0989e462b4bed638d894f Mon Sep 17 00:00:00 2001 From: baranwalayush Date: Tue, 23 Sep 2025 20:52:22 +0530 Subject: [PATCH 2/2] Add CONTRIBUTING.md file --- CONTRIBUTING.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..29482eb3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,48 @@ +# Contributing to SBSCL + +Thank you for your interest in contributing to SBSCL! If you would like to make improvements to the library, add new features that are useful to you and others, or have found a bug that you know how to fix, please open a pull request! + +## How to Contribute + +### Reporting Bugs + +If you find a bug, please open a new issue on our [Issue Tracker](https://github.com/draeger-lab/SBSCL/issues) and provide the following information: + +* **Expected behavior:** What should happen? +* **Actual behavior:** What is happening instead? +* **Reproduction steps:** Clear, concise steps to reproduce the issue. +* **Environment:** Your operating system, version of the project etc. +* **Screenshots or error messages:** If applicable. + +### Suggesting Enhancements + +For feature requests or enhancements, please open a new issue on our [Issue Tracker](https://github.com/draeger-lab/SBSCL/issues) and describe: + +* **The problem you are trying to solve.** +* **Your proposed solution or enhancement.** +* **Any alternative solutions you have considered.** + +### Code Contributions + +1. **Fork** the repository and **clone** it locally. +2. **Create a new branch** for your changes: `git checkout -b your-feature-name`. +3. **Make your changes** and ensure they adhere to our [Coding Style Guide Link, if applicable]. +4. **Write tests** for your changes to ensure functionality and prevent regressions. +5. **Commit your changes** with a clear and descriptive commit message. +6. **Push your branch** to your fork: `git push origin your-feature-name`. +7. **Open a Pull Request (PR)** to the upstream repository. + * Provide a clear description of your changes. + * Reference any related issues. + +## Development Setup + +For more information regarding the installation, refer to [INSTALL.md](INSTALL.md) + +## Getting Help + +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). +* Ask to any maintainer. + +We appreciate your contributions and look forward to collaborating with you! \ No newline at end of file