Skip to content

Commit d49e768

Browse files
Update contributing guide with improved walkthrough and clearer guidelines
Co-authored-by: AndreaGriffiths11 <20666190+AndreaGriffiths11@users.noreply.github.com>
1 parent eb2dd08 commit d49e768

File tree

1 file changed

+70
-9
lines changed

1 file changed

+70
-9
lines changed

CONTRIBUTING.md

Lines changed: 70 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@
44

55
This document provides guidelines and instructions for contributing to the Maintainer Month website.
66

7+
## Getting Started - What do you want to do?
8+
9+
Choose your contribution type to jump to the right section:
10+
11+
### 🎉 **Add a New Event**
12+
Want to showcase your maintainer-focused event during Maintainer Month? → [Jump to Adding a New Event](#adding-a-new-event)
13+
14+
### 📚 **Add a New Resource**
15+
Have a helpful resource for maintainers (article, video, tutorial)? → [Jump to Adding a New Resource](#adding-a-new-resource)
16+
17+
### ✏️ **Fix Typos or Content Issues**
18+
Spotted a typo or content error that needs fixing? → [Jump to Fixing Typos or Content Issues](#fixing-typos-or-content-issues)
19+
20+
### 🔧 **Make Code Changes**
21+
Want to improve the website functionality or structure? → [Jump to Making Code Changes](#making-code-changes)
22+
23+
### 🚀 **Set Up Development Environment**
24+
Need to run the website locally for testing? → [Jump to Development Guidelines](#development-guidelines)
25+
726
## Quick Navigation
827

928
- [How to Contribute](#how-to-contribute)
@@ -68,19 +87,61 @@ Detailed description of your event goes here. You can use markdown formatting.
6887

6988
### Fixing Typos or Content Issues
7089

90+
Found something that needs fixing? We appreciate your help! Here's how to contribute corrections:
91+
92+
#### What to Fix
93+
- Spelling or grammar errors
94+
- Broken links
95+
- Outdated information
96+
- Formatting issues
97+
- Missing or incorrect event details
98+
99+
#### Where to Look
100+
- **Website text:** Files in the `content/` directory
101+
- **Event information:** Files in `content/events/`
102+
- **Resource library:** `content/library/resources.json`
103+
- **Homepage content:** Files in `content/home/`
104+
- **General site text:** `content/commons.json`
105+
106+
#### How to Fix
71107
1. Locate the file with the content that needs correction
72-
- Website text is in the `content/` directory
73-
- For events, check `content/events/`
74-
- For library resources, check `content/library/resources.json`
75-
2. Make your corrections
76-
3. Submit a PR describing what you fixed
108+
2. Make your corrections (keep existing formatting and structure)
109+
3. For events, be careful not to modify frontmatter variable names (between `---`)
110+
4. Submit a PR with a clear description of what you fixed
111+
112+
**Quick Tip:** For simple typos, you can even edit directly on GitHub by clicking the pencil icon on any file!
77113

78114
### Making Code Changes
79115

80-
1. For structural code changes, please open an issue first to discuss your proposal
81-
2. Follow the project's coding style and patterns
82-
3. Test your changes locally before submitting
83-
4. Include clear documentation for any new functionality
116+
We welcome both minor improvements and structural changes, but the process differs:
117+
118+
#### Minor Code Changes
119+
For small improvements like:
120+
- Bug fixes
121+
- UI/UX tweaks
122+
- Performance optimizations
123+
- Code cleanup or refactoring
124+
125+
**Process:**
126+
1. Fork the repository and create a branch
127+
2. Make your changes following existing code patterns
128+
3. Test locally with `npm run dev` and `npm test`
129+
4. Submit a PR with a clear description
130+
131+
#### Structural Code Changes
132+
For significant changes like:
133+
- New features or pages
134+
- Major architectural changes
135+
- New dependencies or build processes
136+
- Breaking changes to existing functionality
137+
138+
**Process:**
139+
1. **Open an issue first** to discuss your proposal with maintainers
140+
2. Wait for feedback and approval before starting work
141+
3. Follow the project's coding style and patterns
142+
4. Test your changes thoroughly locally
143+
5. Include clear documentation for any new functionality
144+
6. Submit a PR referencing the issue
84145

85146
## Development Guidelines
86147

0 commit comments

Comments
 (0)