Skip to content

so-sc/sosc-website-v2

Repository files navigation

Sahyadri OpenSource Community

The official website for Sahyadri OpenSource Community (SOSC) - a student-driven community dedicated to promoting open-source culture and collaborative learning.

All contribution to this website including contents are made through Pull Requests. If you are new to Git and GitHub and don't know how to submit a Pull Request, please refer our friendly guide on submitting your first pull request at gitme.js.org.

Live Website: www.sosc.org.in


About

This website serves as a central hub for:

  • Community events and workshops
  • Technical blog posts and insights
  • Project showcases from our members
  • Learning resources curated for all skill levels

Getting Started

  1. Install dependencies

    npm install
  2. Start the development server

    npm run dev

Creating Content

Using the CLI

The easiest way to create new content is using our CLI tool:

npm run add

Select the content type (blog, event, project, or resource) and follow the prompts. The CLI automatically creates the proper folder structure and template.

Manual Creation

If you prefer to create content manually, ensure you follow the structure and frontmatter requirements below.

Creating a new blog post:

Create a folder in src/content/blogs/ with your slug name (e.g., my-first-blog). Inside, create index.md.

Frontmatter Example:

---
title: "Getting Started with Open Source"
description: "A comprehensive guide to making your first contribution."
date: 2023-10-15
author: "github-username"
cover: "./cover-image.png"
tags: "opensource, git"
---

Creating a new event:

Create a folder in src/content/events/ with the event slug. Inside, create index.md.

Frontmatter Example:

---
name: "DevHost 2023"
date: 2023-11-20
location: "Seminar Hall"
cover: "./event-banner.png"
---

Note: Place image assets in the same folder as the markdown file and reference them relatively.

For complete details on all content types including Projects and Resources, refer to CONTENT_GUIDELINES.md.


Contributing

We welcome contributions from everyone. Whether you are fixing bugs, adding features, improving documentation, or creating content, your help is appreciated.

Contribution Workflow

  1. Fork the repository.
  2. Create a branch for your feature or fix.
    git checkout -b FEAT-your-feature-name
  3. Make your changes and commit using the convention below.
  4. Push to your fork and submit a Pull Request.

Commit Message Conventions

We follow a prefix-based commit format to ensure a clean history:

  • ADD: Added files or content
  • FEAT: New feature
  • FIX: Bug fix or correction
  • SFIX: Security fix
  • TYPO: Typo or documentation fix
  • RFT: Refactored code
  • WIP: Work in progress
  • INIT: Initial setup

Example: FEAT: add dark mode toggle to navbar

For detailed guidelines, please read CONTRIBUTING.md.


Meet Our Contributors


About

May the Source be with you

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors