diff options
| author | aman333nolawz <amananudhiu@gmail.com> | 2026-04-04 02:18:34 +0530 |
|---|---|---|
| committer | aman333nolawz <amananudhiu@gmail.com> | 2026-04-04 02:18:34 +0530 |
| commit | 5878b7cdcdd74b5936ba81d59e28fa154f82724b (patch) | |
| tree | 515cb791d0337b1342395ec14b4907a45cbe81f6 | |
| parent | 0141b8797e4f01094133eae0c062638d88fb552d (diff) | |
Added contribution guide to footer
| -rw-r--r-- | src/components/Footer.astro | 8 | ||||
| -rw-r--r-- | src/pages/_contribute.mdx | 101 | ||||
| -rw-r--r-- | src/pages/contribute.astro | 44 |
3 files changed, 153 insertions, 0 deletions
diff --git a/src/components/Footer.astro b/src/components/Footer.astro index 4471292..4aaaeb6 100644 --- a/src/components/Footer.astro +++ b/src/components/Footer.astro @@ -14,6 +14,14 @@ import SocialIcons from './SocialIcons.astro' <span class="c"> *</span> Status: Up and Running (mostly) <br /> <span class="c"> *</span> Generated at {Date.now()}ms UNIX. <br /> <span class="c"> *</span> + <span class="text-primary">git</span> checkout -b + <Link + href="/contribute" + class="text-foreground" + underline>contribute</Link + > + <br /> + <span class="c"> *</span> <span class="text-primary"><3</span> <Link href="https://codeberg.org/fosscet/" diff --git a/src/pages/_contribute.mdx b/src/pages/_contribute.mdx new file mode 100644 index 0000000..fe326b9 --- /dev/null +++ b/src/pages/_contribute.mdx @@ -0,0 +1,101 @@ +# Contribution Guide + +Welcome! We're thrilled that you're interested in contributing to the [FOSSCET website](https://fosscet.codeberg.page). This site is built by the community, for the community. Whether you want to add your member profile, write a blog post, document an event, or improve the codebase, this guide will help you get started. + +--- + +## Local Development Setup + +To preview your changes locally before submitting them, you'll need to set up the project on your machine. + +You will need either [Node.js](https://nodejs.org/en) and [pnpm](https://pnpm.io), OR [bun](https://bun.sh) installed. + +### 1. Clone the repository + +```bash +git clone https://codeberg.org/fosscet/website-src +cd website-src +pnpm i # or: bun install +``` + +### 2. Start the development server + +```bash +pnpm run dev # or: bun run dev +``` + +### 3. Build the site (Optional) + +To verify that your changes build correctly for production: + +```bash +pnpm run build # or: bun run build +``` + +--- + +## Design & Styling + +For UI contributions or brand assets, please check our [Assets and Style Guide](/styleguide). It contains our official logos, typography, and color scheme + +--- + +## Adding Your Member Profile + +Here is how you can add your very own member card. + +1. Create a markdown file named `<yourname>.md` in the `src/content/members/` directory. + _(Example: If you want your handle to be `nik`, create `src/content/members/nik.md`)_ +2. To upload an avatar, put the image in `./public/images/myavatar.png`, and fill the form like so: `avatar: /public/images/myavatar.png`. +3. Add your details using the frontmatter format below, followed by a longer bio if you'd like! + +### Member Card Template + +Everything except `name` and `avatar` is optional. + +```markdown +--- +name: <Your name> +pronouns: <Your pronouns> +avatar: <Link to an avatar image, e.g., /public/images/myavatar.png> +bio: <A quick, short bio> +website: <Link to your personal website> +github: <Link to your github profile> +codeberg: <Link to your codeberg profile> +linkedin: <Link to your linkedin profile> +instagram: <Link to your instagram profile> +mail: <You email address> +--- + +Detailed bio text goes here. This is a great space to introduce yourself, talk about your favorite FOSS projects, or share your tech stack! This section can be considerably longer than the short `bio` field above. +``` + +--- + +## Writing a Blog Post + +Got an opinion piece, a tutorial, or a FOSS experience to share? We welcome blog contributions! + +1. Create a new file `your-post-title.md` (or `.mdx`) in `src/content/blog/`. +2. Check out `src/content/blog/shortening-of-the-way/index.mdx` for a comprehensive example of the required frontmatter and formatting. +3. **Important:** Remember to remove `draft: true` from your frontmatter when you are ready to publish! + +--- + +## Documenting an Event + +1. Create a new file `event-name.md` (or `.mdx`) in `src/content/events/` +2. Refer to the sample in `src/content/events/event_zero.mdx` for more info + +--- + +## Creating a New Form + +Need to spin up a registration or feedback form? + +1. Create a file `my-form-id.md` in `src/content/forms/`. +2. See the sample at `src/content/forms/test.mdx` for the form configuration schema. + +--- + +_Thank you for contributing to FOSSCET! Every commit helps build a better, more open community._ diff --git a/src/pages/contribute.astro b/src/pages/contribute.astro new file mode 100644 index 0000000..552c235 --- /dev/null +++ b/src/pages/contribute.astro @@ -0,0 +1,44 @@ +--- +import Breadcrumbs from '@/components/Breadcrumbs.astro' +import PageHead from '@/components/PageHead.astro' +import TOCHeader from '@/components/TOCHeader.astro' +import TOCSidebar from '@/components/TOCSidebar.astro' +import Layout from '@/layouts/Layout.astro' + +import { Content, getHeadings } from './_contribute.mdx' +const headings = await getHeadings() + +const sections = [ + { + type: 'parent', + title: 'Contribution Guide', + headings: headings, + }, +] +--- + +<Layout> + <PageHead slot="head" title="Contribution Guide" /> + { + headings.length > 0 && ( + <TOCHeader slot="table-of-contents" headings={headings} /> + ) + } + + <section + class="mt-8 grid grid-cols-[minmax(0px,1fr)_min(calc(var(--breakpoint-md)-2rem),100%)_minmax(0px,1fr)] gap-y-6" + > + <div class="col-start-2"> + <Breadcrumbs + items={[{ label: 'Contribute', icon: 'lucide:git-pull-request' }]} + /> + </div> + + <TOCSidebar sections={sections} currentPostId="contribute" /> + + <article class="prose dark:prose-invert col-start-2 max-w-none"> + <Content /> + </article> + </section> +</Layout> + |
