From e9c06e1ac17e204d6dedebbe439ab8b381a4118e Mon Sep 17 00:00:00 2001 From: Panuluh <69516665+nuluh@users.noreply.github.com> Date: Sat, 7 Sep 2024 09:13:57 +0700 Subject: [PATCH 1/5] Update LICENSE --- LICENSE | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/LICENSE b/LICENSE index e69de29..488f0a3 100644 --- a/LICENSE +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2024 Rifqi D. Panuluh + +All Rights Reserved. + +This repository is for viewing purposes only. No part of this repository, including but not limited to the code, files, and documentation, may be copied, reproduced, modified, or distributed in any form or by any means without the prior written permission of the copyright holder. + +Unauthorized use, distribution, or modification of this repository may result in legal action. -- 2.49.1 From f41edaaa911ca1d7009a88d4712e9809aebcefb9 Mon Sep 17 00:00:00 2001 From: "Rifqi D. Panuluh" <69516665+nuluh@users.noreply.github.com> Date: Mon, 9 Sep 2024 23:13:03 +0700 Subject: [PATCH 2/5] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index e69de29..80c41ef 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,18 @@ +## Summary + +This repository contains the work related to my thesis, which focuses on damage localization prediction. The research explores the application of machine learning techniques to structural health monitoring. + +**Note:** This repository does not contain the secondary data used in the analysis. The code is designed to work with data from the [QUGS (Qatar University Grandstand Simulator)](https://www.structuralvibration.com/benchmark/qugs/) dataset, which is not included here. + +The repository is private and access is restricted only to those who have been given explicit permission by the owner. Access is provided solely for the purpose of brief review or seeking technical guidance. + +## Restrictions + +- **No Derivative Works or Cloning:** Any form of copying, cloning, or creating derivative works based on this repository is strictly prohibited. +- **Limited Access:** Use beyond brief review or collaboration is not allowed without prior permission from the owner. + +--- + +All contents of this repository, including the thesis idea, code, and associated data, are copyrighted © 2024 by Rifqi D. Panuluh. Unauthorized use or duplication is prohibited. + +[LICENSE](https://github.com/nuluh/thesis?tab=License-1-ov-file#readme) -- 2.49.1 From b229967e05f56d060f272884852ad1984d497d91 Mon Sep 17 00:00:00 2001 From: "Rifqi D. Panuluh" <69516665+nuluh@users.noreply.github.com> Date: Mon, 9 Sep 2024 23:14:01 +0700 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 80c41ef..29b847c 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,6 @@ The repository is private and access is restricted only to those who have been g --- -All contents of this repository, including the thesis idea, code, and associated data, are copyrighted © 2024 by Rifqi D. Panuluh. Unauthorized use or duplication is prohibited. +All contents of this repository, including the thesis idea, code, and associated data, are copyrighted © 2024 by Rifqi Panuluh. Unauthorized use or duplication is prohibited. [LICENSE](https://github.com/nuluh/thesis?tab=License-1-ov-file#readme) -- 2.49.1 From 2de04a6ea662eb3b7ccb391490d5c63819bfc37c Mon Sep 17 00:00:00 2001 From: "Rifqi D. Panuluh" <69516665+nuluh@users.noreply.github.com> Date: Sun, 16 Mar 2025 12:02:35 +0700 Subject: [PATCH 4/5] Create CONTRIBUTING.md --- docs/CONTRIBUTING.md | 66 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..3daa472 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,66 @@ +This document outlines the process for developing and contributing to my own thesis project. By following these guidelines, this will ensure consistent quality and maintain a clear development history. + +## Development Workflow + +### 1. Issue Creation +Before working on any new feature, experiment, or bug fix: +- Create a GitHub issue using the appropriate template +- Assign it to myself +- Add relevant labels +- Link it to the project board if applicable + +### 2. Branching Strategy +Use the following branch naming convention: +- `feature/-short-description` +- `bugfix/-short-description` +- `experiment/-short-description` +- `doc/-short-description` + +Always branch from `main` for new features/experiments. + +### 3. Development Process +- Make regular, atomic commits following the commit message template +- Include the issue number in commit messages (e.g., "#42") +- Push changes at the end of each work session + +### 4. Code Quality +- Follow PEP 8 guidelines for Python code +- Document functions with docstrings +- Maintain test coverage for custom functions +- Keep notebooks clean and well-documented + +### 5. Pull Requests +Even working alone, use PRs for significant changes: +- Create a PR from your feature branch to `main` +- Reference the issue(s) it resolves +- Include a summary of changes +- Self-review the PR before merging + +### 6. Versioning +Follow semantic versioning: +- Major version: Significant thesis milestones or structural changes +- Minor version: New experiments, features, or chapters +- Patch version: Bug fixes and minor improvements + +### 7. Documentation +Update documentation with each significant change: +- Keep README current +- Update function documentation +- Maintain clear experiment descriptions in notebooks +- Record significant decisions and findings + +## LaTeX Guidelines +- Use consistent citation style +- Break long sections into multiple files +- Use meaningful label names for cross-references +- Consider using version-control friendly LaTeX practices (one sentence per line) + +## Experiment Tracking +For each experiment: +- Create an issue documenting the experiment design +- Reference related papers and previous experiments +- Document parameters and results in the notebook +- Summarize findings in the issue before closing + +## Commit Categories +Use the categories defined in the commit template to clearly classify changes. -- 2.49.1 From 59aa1243053b959696d2e31b0b72a0cb0ede413f Mon Sep 17 00:00:00 2001 From: nuluh Date: Sun, 16 Mar 2025 12:16:23 +0700 Subject: [PATCH 5/5] chore: add .gitattributes and .gitmessage for commit message guidelines --- .gitattributes | 1 + .gitmessage | 30 ++++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitmessage diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..44fcab8 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.ipynb filter=nbstripout \ No newline at end of file diff --git a/.gitmessage b/.gitmessage new file mode 100644 index 0000000..4afc0c8 --- /dev/null +++ b/.gitmessage @@ -0,0 +1,30 @@ +# .gitmessage + +# (): +# |<---- Using a Maximum Of 50 Characters ---->| +# +# Explain the problem that this commit is solving. Focus on why you +# are making this change as opposed to how. Use clear, concise language. +# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->| +# +# -- COMMIT END -- +# Types: +# feat (new feature) +# fix (bug fix) +# refactor (refactoring code) +# style (formatting, no code change) +# doc (changes to documentation) +# test (adding or refactoring tests) +# perf (performance improvements) +# chore (routine tasks, dependencies) +# exp (experimental work/exploration) +# +# Scope: +# latex (changes to thesis LaTeX) +# src (changes to Python source code) +# nb (changes to notebooks) +# ml (ML model specific changes) +# data (data processing/preparation) +# viz (visualization related) +# all (changes spanning entire repository) +# -------------------- \ No newline at end of file -- 2.49.1