diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4b0fd26 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +## Contributing Instructions + +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.* + +### V2 Information + +- 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`. +- 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. + +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` + +- This is the assets folder. +- Contains important CSS and JavaScript files. + +### `/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` + +- This is the components folder. +- These are referenced in the pages to reduce code duplication. diff --git a/README-DEVS.md b/README-DEVS.md deleted file mode 100644 index e39d469..0000000 --- a/README-DEVS.md +++ /dev/null @@ -1,27 +0,0 @@ -## Dev Readme - -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.* - -### V2 Information - -- 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. - -### /src/assets - -- This is the assets folder. - -### /src/routes - -- This is the folder where the pages are stored. -- All webpages should be called `index.html ` - - -### /src/components - -- This is the components folder. -- These are referenced in the pages to reduce code duplication. \ No newline at end of file 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 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