Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

78 lines (59 loc) · 2.37 KB
Raw

Contributing to 404unfound Repo

Thank you for considering contributing to our repository! We welcome contributions from all members. Please follow the guidelines below to contribute effectively.

Adding Writeups

  1. Fork this repository to your GitHub account.
  2. If necessary, create a folder for the CTF in content/writeups.
  3. Inside the CTF folder, create a Markdown(.md) file for your writeup using the following template:
---
title: "[CTF Name] Challenge Name"
date: YYYY-MM-DDTHH:MM:SS+08:00
authors:
  - your name
tags:
  - ctf category
ctfs:
  - ctf name
---

# Challenge Name
Your writeup content goes here.

To embed an image, add it to the same directory (folder) and use the following Markdown format:

![Image](image.png)

OR automatically generate the Markdown file using:

hugo new content/writeups/.../index.md
  1. Make sure to replace [CTF Name], Challenge Name, YYYY-MM-DDTHH:MM:SS+08:00, Your Name, and ctf category with the appropriate information, where needed.

Adding Profile Info

  1. Fork this repository to your GitHub account.
  2. Thank you for being a part of our CTF team! To add your profile information, open the data/members.yml file and add in your information following this format:
- name: Your Name
  course: Your Course
  pfp: your_profile_picture.jpeg
  roles:
    - CTF Role 1
    - CTF Role 2
  desc: Your description or bio
  linkedin: https://www.linkedin.com/in/yourprofile
  github: https://github.com/yourgithub
  twitter: https://https://twitter.com/yourtwitter
  personal: https://www.yourwebsite.com

Note that pfp, linkedin, github, twitter and personal are optional fields.

  1. Ensure that you replace the placeholders with your actual information.

  2. If you are adding a profile picture, add it to the static/profile_pics/ directory.

Submitting Your Changes

  1. Create a new branch for your changes:
git checkout -b your-feature
  1. Commit your changes with clear and concise messages.
  2. Push your changes to your forked repository:
git push origin your-feature
  1. Create a pull request (PR) to the main branch of the 404unfound repository. Include a descriptive title and provide details about your changes in the PR description.
  2. Your PR will be reviewed, and if everything is in order, it will be merged :D

Thank you for contributing to the 404unfound CTF Team repository!