Merge pull request #110 from ASU-CodeDevils/dev

Dev

Author: PitaFLAME

.github/CONTRIBUTING.MD

@@ -59,11 +59,23 @@ Some example branch names:
 ```fix/110/fix-org-link ```
 
 
-#### Commits and Pull Requests
+#### Commits
+
+To the best of your ability, please try to keep the commits to your Issue Branch as few as possible.  If there end up being a lot of commits on your branch, please squash them before you create your Pull Request.
+
+Your Commits do not have any requirements for their naming convention, other than being vaguely relevant to the actions taken.  They need not be anything more than a short description of your changes
+
+#### Pull Requests
 
 After you have finished working on an Issue and you have a finished version of your code, commit it to your branch, and create a Pull Request to merge your Issue Branch to `dev`.
 
-To the best of your ability, please try to keep the commits to your Issue Branch as few as possible.  If there end up being a lot of commits on your branch, please squash them before you create your Pull Request.
+Your Pull Requests have some requirements for documentation.  They must include:
+- An explanation of the changes you made.
+   - For issues tagged "simple", this need not be very detailed, but just a note of what you did.
+   - For issues with no complexity tag, give a reasonable explanation for the changes you made.  It should be comprehensive.  You are welcome to mention anything interesting about your solution.
+   - For issues tagged "complex", you MUST explain why you made any choices that you did for how you approached the issue, in addition to a reasonable explanation for your changes.
+- You must link the issue that you are working on at the end of the Pull Request.  To do this, you must type a '#' character, and follow it with the Issue Number.  This will indicate on the Issue itself that this Pull Request resolves it.  For example, if you are working issue 99, you need to end your Pull Request with '#99'
+
 
 #### Main vs Dev Branch
 

.github/ISSUE_GUIDE.MD

@@ -0,0 +1,38 @@
+# Before you create an Issue...
+
+We're glad that you're here to report an issue with our project.  Please keep in mind, that many problems or inconsistencies with our code is known by our team.  Our Project Leads release issues to our contributors to keep consistent work available to our teams.  While outside issues are allowed, they will not be counted as contribution unless it is approved by the Project Lead.
+
+## Reach out to the Project Lead
+
+The best way to get your issue addressed as a contributor is to reach out to your Project Lead in your team channels.  You may often get automatic assignment to an issue that you identify ahead of an issue's posting, and a Project Lead may grant you extra points for having identified it.  
+
+As an outside reviewer, you may create an issue for the project, but you MUST tag your issue with the tag "non-PL", or it will be closed.
+
+# Template and Requirements
+
+When creating an issue as an outside reviewer, please follow one of the following guides depending on your type of issue:
+
+## Type 1:
+
+Your issue is a Type 1 issue if you are simply noticing and reporting a problem with the project as a user.  Experienced bugs, broken things, etc.
+
+- Issue Name: ```(USER PROBLEM) [Description of your issue]```
+- Issue Description:
+    Your issue description MUST contain a detailed explanation of the issue.  If there are any visual elements involved, screenshots or screen recordings of an issue replication MUST be included.
+
+    **DO NOT** include any reference to the code with this issue type.  If you experience this issue, and have found a way to fix it, please leave it for our contributors to work out how they may debug the issue themselves.  If you would like to share your solution, please message the Project Lead.
+- Labels: Your Issue must have the "non-PL" tag.
+
+## Type 2:
+
+Your issue is a Type 2 issue if you are reviewing the code as an outside reviewer and have a suggestion for how the code can be improved.
+
+- Issue Name: ```(REVIEWER SUGGESTION) [Description of your suggestion]```
+- Issue Description:
+    Your issue description MUST contain the following:
+    - A detailed description of the section of code needing improvement.
+    - A reasonable explanation as to why it needs improvement.
+    - Suggestions for improvement WITHOUT implementing the solution yourself.
+
+    **DO NOT** include your own work in this issue type.  You simply need to point out a flaw in the code and tell us why you believe it needs to be improved and in what way.
+- Labels: Your Issue must have the "non-PL" tag.

README.md

@@ -4,50 +4,35 @@
 
 This is the official repository for CodeDevils' website. It's built using the [Next.js](https://nextjs.org) framework, [Tailwind CSS](https://tailwindcss.com/), and [TypeScript](https://www.typescriptlang.org/). The website is hosted on [Vercel](https://vercel.com).
 
-## Why are there `.js` files in here?
 
-As per [T3-Axiom #3](https://github.com/t3-oss/create-t3-app/tree/next#3-typesafety-isnt-optional), we take typesafety as a first class citizen. Unfortunately, not all frameworks and plugins support TypeScript which means some of the configuration files have to be `.js` files.
+## The Project
 
-We try to emphasize that these files are javascript for a reason, by explicitly declaring its type (`cjs` or `mjs`) depending on what's supported by the library it is used by. Also, all the `js` files in this project are still typechecked using a `@ts-check` comment at the top.
+Packages:
 
-## Contributing (Getting Started)
+- [PNPM](https://pnpm.io/installation)
+- [Node.js](https://nodejs.org/en/download/)
+- [Git](https://git-scm.com/downloads)
 
-1. Pre-requisites:
+Installing the project:
 
-   - [PNPM](https://pnpm.io/installation)
-   - [Node.js](https://nodejs.org/en/download/)
-   - [Git](https://git-scm.com/downloads)
-
-2. Clone the repository:
+1. Clone the repository:
    ```sh
     git clone https://github.com/ASU-CodeDevils/codedevils.org.git
    ```
-3. Install the dependencies:
+2. Install the dependencies:
    ```sh
    pnpm install
    ```
-4. Run the development server:
+3. Run the development server:
    ```sh
     pnpm dev
    ```
 
-## Contributing (Code Style)
-
-This project uses [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) to enforce code style. Please make sure to run `pnpm format`, then `pnpm lint` before committing your changes.
-
-## Contributing (Commit Messages)
-
-This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to enforce a consistent commit message format. Please make sure to follow the commit message format when making changes.
-
-```
-<type>[optional scope]: <description>
-
-[optional body]
+## Contributing
 
-[optional footer(s)]
+[Check out our Contribution Guide here!](https://github.com/ASU-CodeDevils/codedevils.org/blob/main/.github/CONTRIBUTING.MD)
 
-```
 
-## Contributing (Pull Requests)
+## Creating Issues
 
-Please make sure to follow the pull request template when creating a pull request.
+[Check out our Issue Creation Guide here!](https://github.com/ASU-CodeDevils/codedevils.org/blob/main/.github/ISSUE_GUIDE.MD)

package.json

@@ -9,7 +9,7 @@
     "start": "next start",
     "lint": "next lint",
     "format": "prettier --write ."
-  }, 
+  },
   "dependencies": {
     "@next/bundle-analyzer": "^14.0.4",
     "@react-three/drei": "^9.102.5",

src/app/(main)/(routes)/projects/content.tsx

@@ -35,7 +35,8 @@ const projectTeams = {
     academy: [['pita'],
             ],
     website: [  ['pita'],
-                ['David Fales']
+                ['Juliana Bush'],
+                ['Ella Rushing']
             ],
     gamedev: [  ['remi'],
                 ['Autumn O'],