diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index f3ba832..27c85b0 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,31 +1,10 @@ -# Lines starting with '#' are comments. -# Each line is a file pattern followed by one or more owners. +# CODEOWNERS +# SAM-BIM – repository ownership definition # https://github.blog/2017-07-06-introducing-code-owners/ -# SAM REPO CODEOWNERS - -# default global -# These owners will be the default owners for everything in the repo - +# Default owners for the entire repository * @michaldengusiak @ZiolkowskiJakub - -# project owners -# Order is important. The last matching pattern has the most precedence. -# So if a pull request only touches javascript files, only these owners -# will be requested to review. - -/SAM @michaldengusiak @ZiolkowskiJakub -/SAM_BHoM @michaldengusiak @ZiolkowskiJakub -/SAM_Excel @michaldengusiak @ZiolkowskiJakub -/SAM_LadybugTools @michaldengusiak @ZiolkowskiJakub -/SAM_Revit @michaldengusiak @ZiolkowskiJakub -/SAM_Tas @michaldengusiak @ZiolkowskiJakub -/SAM_Topologic @michaldengusiak @ZiolkowskiJakub -/SAM_UI @michaldengusiak @ZiolkowskiJakub -/SAM_gbXML @michaldengusiak @ZiolkowskiJakub -/SAM_GEM @michaldengusiak @ZiolkowskiJakub -/SAM_Template @michaldengusiak @ZiolkowskiJakub - - -# You can also use email addresses if you prefer. \ No newline at end of file +# Governance & workflow files (always require both owners) + /CODEOWNERS @michaldengusiak @ZiolkowskiJakub + /.github/ @michaldengusiak @ZiolkowskiJakub \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 597e853..d4a4c35 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,5 @@ -### NOTE: Depends on - - +### Summary +What is delivered and why (1–3 sentences). - -### Issues addressed by this PR - - -Fixes # - - - - -### Test files - - - -### Additional comments - \ No newline at end of file +### Validation +How to verify or test the change. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b963f48..cebc2d1 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -48,7 +48,6 @@ jobs: # Keep the current repo LAST. $buildOrder = @( 'SAM' - 'SAM_SQL' $repo ) @@ -88,7 +87,6 @@ jobs: # Same build order as above (keep repo LAST) $buildOrder = @( 'SAM' - 'SAM_SQL' $repo ) diff --git a/.github/workflows/spdx-check.yml b/.github/workflows/spdx-check.yml index 9b1f74e..269d562 100644 --- a/.github/workflows/spdx-check.yml +++ b/.github/workflows/spdx-check.yml @@ -29,7 +29,7 @@ jobs: HEADBLOCK=$(head -n 6 "$f") echo "$HEADBLOCK" | grep -q "// SPDX-License-Identifier: LGPL-3.0-or-later" || MISSING="$MISSING $f" - echo "$HEADBLOCK" | grep -q "// Copyright (c) 2020–2025 Michal Dengusiak & Jakub Ziolkowski and contributors" || MISSING="$MISSING $f" + echo "$HEADBLOCK" | grep -q "// Copyright (c) 2020–2026 Michal Dengusiak & Jakub Ziolkowski and contributors" || MISSING="$MISSING $f" done if [ -n "$MISSING" ]; then diff --git a/README.md b/README.md index 8dc6004..697d0f4 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,65 @@ -[![Build](https://github.com/SAM-BIM/SAM_SQL/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/SAM-BIM/SAM_SQL/actions/workflows/build.yml) +[![Build (Windows)](https://github.com/SAM-BIM/SAM_SQL/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/SAM-BIM/SAM_SQL/actions/workflows/build.yml) [![Installer (latest)](https://img.shields.io/github/v/release/SAM-BIM/SAM_Deploy?label=installer)](https://github.com/SAM-BIM/SAM_Deploy/releases/latest) - # SAM_SQL - + + + + +**SAM_SQL** is part of the **SAM (Sustainable Analytical Model) Toolkit** — +an open-source collection of tools designed to help engineers create, manage, +and process analytical building models for energy and environmental analysis. + +This repository provides **database-agnostic SQL persistence, querying, and data-access utilities** +and is intended to be used alongside the SAM core libraries and related SAM-BIM modules. + +Welcome — and let’s keep the open-source journey going. 🤝 -**SAM** is part of SAM Toolkit that is designed to help engneers to create Analytical Model. Welcome and let's make the opensource journey continue. :handshake: +--- ## Resources -* [Wiki](https://github.com/HoareLea/SAM/wiki) +- 📘 **SAM Wiki:** https://github.com/SAM-BIM/SAM/wiki +- 🧠 **SAM Core:** https://github.com/SAM-BIM/SAM +- 🧰 **Installers:** https://github.com/SAM-BIM/SAM_Deploy + +--- ## Installing -To install **SAM** from .exe just download and run [latest installer](https://github.com/HoareLea/SAM_Deploy/releases) otherwise rebuild using VS [SAM](https://github.com/HoareLea/SAM) +To install **SAM** using the Windows installer, download and run the +[latest installer](https://github.com/SAM-BIM/SAM_Deploy/releases/latest). + +Alternatively, you can build the toolkit from source using Visual Studio. +See the main repository for details: +👉 https://github.com/SAM-BIM/SAM + +--- + +## Development notes + +- Target framework: **.NET / C#** +- Coding style follows standard SAM-BIM conventions. +- New or modified `.cs` files must include the SPDX header: + +```csharp +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright (c) 2020-2026 Michal Dengusiak & Jakub Ziolkowski and contributors +``` + + +## Licence + +This repository is free software licensed under the +**GNU Lesser General Public License v3.0 or later (LGPL-3.0-or-later)**. + +Each contributor retains copyright to their respective contributions. +The project history (Git) records authorship and provenance of all changes. + +See: +- `LICENSE` +- `NOTICE` +- `COPYRIGHT_HEADER.txt` -## Licence ## -SAM is free software licenced under GNU Lesser General Public Licence - [https://www.gnu.org/licenses/lgpl-3.0.html](https://www.gnu.org/licenses/lgpl-3.0.html) -Each contributor holds copyright over their respective contributions. -The project versioning (Git) records all such contribution source information. -See [LICENSE](https://github.com/HoareLea/SAM_Template/blob/master/LICENSE) and [COPYRIGHT_HEADER](https://github.com/HoareLea/SAM/blob/master/COPYRIGHT_HEADER.txt).