From f8be60dbfcb59e0e095aec45e19a0bfca33d3022 Mon Sep 17 00:00:00 2001 From: Vihaan Kerekatte Date: Thu, 28 May 2026 11:02:17 -0400 Subject: [PATCH 1/2] setup: add contribution guidelines --- CONTRIBUTING.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f6c652e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,82 @@ +# Git Workflow + +## Branches + +Use `setup`, `feature`, or `fix` branches instead of committing directly to `main`. + +Examples: + +```txt +setup/initial-page +setup/folder-structure +feature/sponsors-section +feature/schedule-page +fix/nav-alignment +fix/mobile-layout +``` + +## Pull Requests + +After making changes to the files, do the following: + +1. Check what files were changed using `git status`. Ensure that only the files you've changed are listed there. Ensure that any keys and the following files aren't being committed: + + ```txt + .env + .env.local + node_modules + ``` + +2. Move the changes (files you want to commit) from your working directory to the staging area by running either `git add ` to stage a specific file or `git add .` to stage all new and modified files. + +3. Permanently save those staged changes to your local database by running `git commit -m "your commit message here"`. + +4. Push your local commits to the GitHub repository by running `git push`. + +5. Go to the GitHub repository via https://github.com/HackNC/fall2026. + +6. Once you're on the GitHub repository, an orange banner will show up stating something along the lines of ` had recent pushes