Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 0 additions & 27 deletions README-DEVS.md

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)
1 change: 1 addition & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## `src` Folder
1 change: 1 addition & 0 deletions src/Templates/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## Templates Folder
1 change: 1 addition & 0 deletions src/assets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## Assets Folder
1 change: 1 addition & 0 deletions src/components/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## Components Folder