diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6b5c6fa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,210 @@ +# Contributing to the Website + +Thank you for contributing to the .devClub website. + +Before making changes: + +1. Create a new branch from `main` +2. Make your changes +3. Test the site locally +4. Open a Pull Request + +--- + +# Adding New Executives + +Executive team members are configured in: + +``` +src/resources/data/teamConfig.ts +``` + +Add a new year entry containing all executives for that year. + +Example: + +```ts +"20xx": [ + { + firstName: "Person", + middleName: "Number", // optional + lastName: "One", + role: "Executive role", + image: "/assets/team/20xx/headshot.png", + linkedin: "https://linkedin.com/in/username", + github: "https://github.com/username", + instagram: "", // optional + discord: "", // optional + website: "" // optional + } +] +``` + +Place the corresponding headshot image in: + +``` +public/assets/team/20xx/ +``` + +--- + +# Adding New Events + +Events are configured in: + +``` +src/resources/data/events.ts +``` + +Add a new entry including: + +- Event name +- Description +- Event image/banner +- Optional path/link +- Optional recurring flag + +Run the project locally to verify the event renders correctly. + +--- + +# Adding Upcoming Events + +Upcoming events are also configured in: + +``` +src/resources/data/events.ts +``` + +Fields you may use: + +- `upcomingTitle` +- `upcomingDescription` +- `date` +- `location` +- `rsvp` +- `upcomingImage` + +If unsure about fields, check: + +``` +src/resources/data/types.ts +``` + +--- + +# Adding a New .devHacks Page + +Open: + +``` +src/resources/data/hackathonInfoConfig.ts +``` + +Add a new year entry with the relevant hackathon information. + +A route will automatically be created: + +``` +/devhacks/20xx +``` + +Run the project locally and verify the page works. + +--- + +# Adding Prize Categories for .devHacks + +Update `hackathonThemeConfig.ts` with: + +- A new year entry +- Prize name +- Description + +Confirm the prize appears correctly on a +`devhacks/202x/themes` route. + +--- + +# Adding Sponsors for .devHacks + +1. Add sponsor logos to the correct devhacks year folder inside: + +``` +src/resources/images/devhacks/202x/sponsors +``` + +2. Import them in: + +``` +src/resources/data/devHacksArchive/HackathonYearSponsors.tsx +``` + +Verify the images load and display properly. + +--- + +# Adding Pictures for .devHacks + +1. Add images to the correct devhacks year folder inside: + +``` +src/resources/images/images/devhacks/202x/pictures +``` + +2. Import them in: + +``` +src/resources/data/devHacksArchive/HackathonYearPictures.tsx +``` + +Confirm the gallery displays correctly. + +--- + +# Adding .devHacks Winners + +Winners are configured in: + +``` +src/resources/data/hackathonWinners.ts +``` + +Add: + +- Project name +- Team members +- Prize category + +Verify spelling and formatting before committing. + +--- + +# Adding Archive Cards to the Main .devHacks Page + +Archive cards display previous hackathons. + +Add a card containing: + +- Hackathon year +- Title +- Short description +- Image +- Link to the hackathon page + +Confirm it appears in the archive section. + +--- + +# Notes for Contributors + +Before opening a Pull Request: + +- Test changes locally +- Follow existing code style +- Verify images and links load correctly +- Avoid committing unnecessary files + +--- + +Thank you for helping improve the **.devClub website** 🚀 diff --git a/README.md b/README.md index a0fe117..dc8a135 100644 --- a/README.md +++ b/README.md @@ -43,215 +43,6 @@ Open [http://localhost:5173](http://localhost:5173) to view local version of the Every time a commit is made to the `main` branch, the react source code is automatically built and published to the `gh-pages` branch, which is then used to serve the users. So you don't need to worry about deployment of your code: As long as your changes are in the `main` branch, they will be reflected on the actual website within 1-3 minutes. ---- +## Contributing -# Contributing to the Website - -Thank you for contributing to the .devClub website. - -Before making changes: - -1. Create a new branch from `main` -2. Make your changes -3. Test the site locally -4. Open a Pull Request - ---- - -# Adding New Executives - -Executive team members are configured in: - -``` -src/resources/data/teamConfig.ts -``` - -Add a new year entry containing all executives for that year. - -Example: - -```ts -"20xx": [ - { - firstName: "Person", - middleName: "Number", // optional - lastName: "One", - role: "Executive role", - image: "/assets/team/20xx/headshot.png", - linkedin: "https://linkedin.com/in/username", - github: "https://github.com/username", - instagram: "", // optional - discord: "", // optional - website: "" // optional - } -] -``` - -Place the corresponding headshot image in: - -``` -public/assets/team/20xx/ -``` - ---- - -# Adding New Events - -Events are configured in: - -``` -src/resources/data/events.ts -``` - -Add a new entry including: - -- Event name -- Description -- Event image/banner -- Optional path/link -- Optional recurring flag - -Run the project locally to verify the event renders correctly. - ---- - -# Adding Upcoming Events - -Upcoming events are also configured in: - -``` -src/resources/data/events.ts -``` - -Fields you may use: - -- `upcomingTitle` -- `upcomingDescription` -- `date` -- `location` -- `rsvp` -- `upcomingImage` - -If unsure about fields, check: - -``` -src/resources/data/types.ts -``` - ---- - -# Adding a New .devHacks Page - -Open: - -``` -src/resources/data/hackathonInfoConfig.ts -``` - -Add a new year entry with the relevant hackathon information. - -A route will automatically be created: - -``` -/devhacks/20xx -``` - -Run the project locally and verify the page works. - ---- - -# Adding Prize Categories for .devHacks - -Update `hackathonThemeConfig.ts` with: - -- A new year entry -- Prize name -- Description - -Confirm the prize appears correctly on a -`devhacks/202x/themes` route. - ---- - -# Adding Sponsors for .devHacks - -1. Add sponsor logos to the correct devhacks year folder inside: - -``` -src/resources/images/devhacks/202x/sponsors -``` - -2. Import them in: - -``` -src/resources/data/devHacksArchive/HackathonYearSponsors.tsx -``` - -Verify the images load and display properly. - ---- - -# Adding Pictures for .devHacks - -1. Add images to the correct devhacks year folder inside: - -``` -src/resources/images/images/devhacks/202x/pictures -``` - -2. Import them in: - -``` -src/resources/data/devHacksArchive/HackathonYearPictures.tsx -``` - -Confirm the gallery displays correctly. - ---- - -# Adding .devHacks Winners - -Winners are configured in: - -``` -src/resources/data/hackathonWinners.ts -``` - -Add: - -- Project name -- Team members -- Prize category - -Verify spelling and formatting before committing. - ---- - -# Adding Archive Cards to the Main .devHacks Page - -Archive cards display previous hackathons. - -Add a card containing: - -- Hackathon year -- Title -- Short description -- Image -- Link to the hackathon page - -Confirm it appears in the archive section. - ---- - -# Notes for Contributors - -Before opening a Pull Request: - -- Test changes locally -- Follow existing code style -- Verify images and links load correctly -- Avoid committing unnecessary files - ---- - -Thank you for helping improve the **.devClub website** 🚀 +Please read the [Contributing Guide](CONTRIBUTING.md) before opening a pull request. diff --git a/public/SponsorshipPackage.pdf b/public/SponsorshipPackage.pdf deleted file mode 100644 index 3ec052e..0000000 Binary files a/public/SponsorshipPackage.pdf and /dev/null differ