Add branching and workflow guidelines to CONTRIBUTING.md; update README for clarity in example usage

nikoscham · nikoscham · commit 2a18a9e6e001 · 2025-05-21T08:19:21.000+03:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -27,6 +27,15 @@ Thank you for your interest in contributing! FEAScript is in early development,
 
    where the server will be available at `http://127.0.0.1:8000/`. Static file server npm packages like [serve](https://github.com/vercel/serve#readme) and [Vite](https://vite.dev/) can also be used.
 
+## Branching & Workflow
+
+To contribute a new feature or fix:
+
+- Do not commit directly to `main` or `dev`.
+- Instead, start your work in a feature branch based on the `dev` branch.
+
+**If you are not a member of the repository (e.g., an external contributor), you must first [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).** Make your changes in your fork, then submit a Pull Request from your fork's feature branch into the`dev` branch.
+
 ## File Structure Guidelines
 
 All files in the FEAScript-core codebase should follow this structure:
diff --git a/README.md b/README.md
@@ -13,17 +13,13 @@ FEAScript is entirely implemented in pure JavaScript and requires only a simple
 ### Example Usage
 
 ```javascript
-// Import required modules
+// Import FEAScript library
 import { FEAScriptModel, plotSolution } from "https://core.feascript.com/src/index.js";
 
-// Create a new FEAScript model
+// Create and configure model
 const model = new FEAScriptModel();
-
-// Configure the solver
 model.setSolverConfig("solverType"); // e.g., "solidHeatTransfer" for a stationary solid heat transfer case
-
-// Define mesh configuration (assuming a rectangular domain for 2D)
-model.setMeshConfig({
+model.setMeshConfig({ // Define mesh configuration (assuming a rectangular domain for 2D)
   meshDimension: "1D" | "2D", // Mesh dimension
   elementOrder: "linear" | "quadratic", // Element order
   numElementsX: number, // Number of elements in x-direction
@@ -32,16 +28,13 @@ model.setMeshConfig({
   maxY: number, // Domain length in y-direction (for 2D)
 });
 
-// Define boundary conditions
-model.addBoundaryCondition("boundaryIndex", ["conditionType", ...parameters]);
-
-// Set solver method
-model.setSolverMethod("solverMethod"); // e.g., "lusolve" for LU decomposition
+// Apply boundary conditions
+model.addBoundaryCondition("boundaryIndex", ["conditionType", /* parameters */]);
 
-// Solve the problem
+// Solve
 const { solutionVector, nodesCoordinates } = model.solve();
 
-// Visualize results
+// Plot results
 plotSolution(
   solutionVector,
   nodesCoordinates,
