From 588534c3cb7e8aa43e07cb3ecae6f13d167dbee6 Mon Sep 17 00:00:00 2001 From: Synaptic <59460385+Synaptic149@users.noreply.github.com> Date: Wed, 28 May 2025 13:03:24 -0700 Subject: [PATCH 1/7] Update README-DEVS.md with grammar fixes --- README-DEVS.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README-DEVS.md b/README-DEVS.md index e39d469..e7c69e3 100644 --- a/README-DEVS.md +++ b/README-DEVS.md @@ -1,6 +1,6 @@ ## Dev Readme -This will provide you with a definition of the folder structure, best development practices, and dev related changes in version 2. +This will provide you with a definition of the folder structure, best development practices, and dev-related changes in version 2. *This guide is not complete yet.* @@ -9,7 +9,7 @@ This will provide you with a definition of the folder structure, best developmen - This is Version 2 of the Hawkbot1cs website - V2 is easier to edit and change using basic `html`, as this version has removed `.svelte`. - New pages can now be created and ready to push in minutes by duplicating and modifying an `.html` file in `src/routes/Templates`. -- Navbar and footer are can now be modified site-wide from one file. +- The navbar and footer can now be modified site-wide from a single file. ### /src/assets @@ -24,4 +24,4 @@ This will provide you with a definition of the folder structure, best developmen ### /src/components - This is the components folder. -- These are referenced in the pages to reduce code duplication. \ No newline at end of file +- These are referenced in the pages to reduce code duplication. From 4c578cfab142ff637322328ed3557291254b4af0 Mon Sep 17 00:00:00 2001 From: Synaptic <59460385+Synaptic149@users.noreply.github.com> Date: Wed, 28 May 2025 13:05:51 -0700 Subject: [PATCH 2/7] add dev practices to README-DEVS.md --- README-DEVS.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README-DEVS.md b/README-DEVS.md index e7c69e3..bb02761 100644 --- a/README-DEVS.md +++ b/README-DEVS.md @@ -11,6 +11,10 @@ This will provide you with a definition of the folder structure, best developmen - New pages can now be created and ready to push in minutes by duplicating and modifying an `.html` file in `src/routes/Templates`. - The navbar and footer can now be modified site-wide from a single file. +### Development Best Practices + +If you'd like to add a feature to the website, please check if there is an existing branch or pull request already for the feature you are looking to add. Doing so helps prevent merge conflicts and redundant work. + ### /src/assets - This is the assets folder. From 71ccb8c7b2573f5118de2af2aed8c70ae436fff9 Mon Sep 17 00:00:00 2001 From: Synaptic Date: Fri, 30 May 2025 07:27:54 -0700 Subject: [PATCH 3/7] added contribution instructions --- README-DEVS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README-DEVS.md b/README-DEVS.md index bb02761..4aee8cb 100644 --- a/README-DEVS.md +++ b/README-DEVS.md @@ -15,6 +15,8 @@ This will provide you with a definition of the folder structure, best developmen If you'd like to add a feature to the website, please check if there is an existing branch or pull request already for the feature you are looking to add. Doing so helps prevent merge conflicts and redundant work. +If there is no brancn or PR for the feature you want, either create a new branch for the feature, or fork the repository. Make sure you start a pull request once you start making changes. + ### /src/assets - This is the assets folder. From c9c3866bb4321025df26c6e1a9fb6e6be46a6ade Mon Sep 17 00:00:00 2001 From: Synaptic <59460385+Synaptic149@users.noreply.github.com> Date: Sun, 1 Jun 2025 21:54:00 -0700 Subject: [PATCH 4/7] Rename README-DEVS.md to CONTRIBUTING.md --- README-DEVS.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README-DEVS.md => CONTRIBUTING.md (100%) diff --git a/README-DEVS.md b/CONTRIBUTING.md similarity index 100% rename from README-DEVS.md rename to CONTRIBUTING.md From 6467ea6125703dfd72a6c16cae7de0c74b8d2e30 Mon Sep 17 00:00:00 2001 From: Synaptic Date: Tue, 3 Jun 2025 10:01:03 -0700 Subject: [PATCH 5/7] created readme.md files for important folders --- src/README.md | 1 + src/Templates/README.md | 1 + src/assets/README.md | 1 + src/components/README.md | 1 + 4 files changed, 4 insertions(+) create mode 100644 src/README.md create mode 100644 src/Templates/README.md create mode 100644 src/assets/README.md create mode 100644 src/components/README.md diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..476a44f --- /dev/null +++ b/src/README.md @@ -0,0 +1 @@ +## `src` Folder \ No newline at end of file diff --git a/src/Templates/README.md b/src/Templates/README.md new file mode 100644 index 0000000..d0ca334 --- /dev/null +++ b/src/Templates/README.md @@ -0,0 +1 @@ +## Templates Folder \ No newline at end of file diff --git a/src/assets/README.md b/src/assets/README.md new file mode 100644 index 0000000..4e1b3ea --- /dev/null +++ b/src/assets/README.md @@ -0,0 +1 @@ +## Assets Folder \ No newline at end of file diff --git a/src/components/README.md b/src/components/README.md new file mode 100644 index 0000000..e89bf73 --- /dev/null +++ b/src/components/README.md @@ -0,0 +1 @@ +## Components Folder \ No newline at end of file From edb3765f9f1ef5b0b13f8eff5043cb23d56c3411 Mon Sep 17 00:00:00 2001 From: Synaptic Date: Tue, 3 Jun 2025 10:07:18 -0700 Subject: [PATCH 6/7] update readme link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a8b1d0b..ec4ecbb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ # Website -The Hawkbot1cs website. For dev info, see [README-DEVS.md](README-DEVS.md) +The Hawkbot1cs website. For dev info, see [README-DEVS.md](CONTRIBUTING.md) \ No newline at end of file From 3e66efbd93c12c8dd3ad6cbd029f3f63a2bdd076 Mon Sep 17 00:00:00 2001 From: Synaptic Date: Tue, 3 Jun 2025 10:23:37 -0700 Subject: [PATCH 7/7] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4aee8cb..4b0fd26 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -## Dev Readme +## Contributing Instructions This will provide you with a definition of the folder structure, best development practices, and dev-related changes in version 2. @@ -15,19 +15,21 @@ This will provide you with a definition of the folder structure, best developmen If you'd like to add a feature to the website, please check if there is an existing branch or pull request already for the feature you are looking to add. Doing so helps prevent merge conflicts and redundant work. -If there is no brancn or PR for the feature you want, either create a new branch for the feature, or fork the repository. Make sure you start a pull request once you start making changes. +If there is no branch or PR for the feature you want, either create a new branch for the feature, or fork the repository. Make sure you start a pull request once you start making changes and push frequently. -### /src/assets +### `/src/assets` - This is the assets folder. +- Contains important CSS and JavaScript files. -### /src/routes +### `/src/routes` - This is the folder where the pages are stored. +- Each page must be in its own folder. - All webpages should be called `index.html ` -### /src/components +### `/src/components` - This is the components folder. - These are referenced in the pages to reduce code duplication.