Skip to content

Update README.md #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #296

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc62f4e
Update README.md
karasowles Apr 23, 2025
43b96f1
Update README.md
karasowles Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 65 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A month for open source maintainers to gather, share, and be celebrated. 🥳

Repository for the official GitHub Maintainer Month website. You can access the website through [this link](https://maintainermonth.github.com/)
Repository for the official GitHub Maintainer Month website. You can access the website through [this link](https://maintainermonth.github.io/)

**Add your event!** See the [contributing guide](CONTRIBUTING.md) for details on how.

Expand All @@ -11,41 +11,100 @@ Repository for the official GitHub Maintainer Month website. You can access the
## Table of Contents

- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Build](#build)
- [Testing](#testing)
- [Project Structure](#project-structure)
- [Adding Events](#adding-events)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Maintainer Month Origins](#maintainer-month-origins)
- [License](#license)

## Getting Started

### Prerequisites

- Node.js (version 16.x or higher recommended)
- npm or yarn

### Installation

Run the following command before any other to install all the project's dependencies.

```
```bash
# Using npm
npm install

# Using yarn
yarn install
```

### Usage

To start application in development mode at [http://localhost:3000](http://localhost:3000) run the following command.

```
yarn start
```bash
# Using npm
npm run dev

# Using yarn
yarn dev
```

### Build

To generate the application build run the following command

```
```bash
# Using npm
npm run build

# Using yarn
yarn build
```

This will create an `out` folder in the repository root with the static files.

### Testing

To run the test suite:

```bash
# Using npm
npm test

# Using yarn
yarn test
```

## Project Structure

This project is built with Next.js and React, with SASS for styling:

- `/components` - React components for the website
- `/pages` - Next.js pages
- `/public` - Static assets
- `/styles` - SASS stylesheets
- `/content` - Content files for events, news, and other information
- `/api` - API endpoints

## Adding Events

To add an event to Maintainer Month 2025:

1. Create a new Markdown file in the `/content/events/` directory
2. Name it with format `YYYY-MM-DD-EventName.md`
3. Include the required frontmatter (details in [CONTRIBUTING.md](CONTRIBUTING.md))
4. Submit a pull request with your changes

## Deployment

The site is automatically deployed when changes are merged to the main branch.

## Contributing

See the [contributing guide](CONTRIBUTING.md) for more details.
Expand All @@ -62,3 +121,4 @@ Maintainer Month was created, and is maintained, by GitHub, starting in 2021 as

Copyright © 2025 [GitHub](https://github.com/github).<br />
This project is [MIT](LICENSE) licensed.