Skip to content

Commit 5f0cb35

Browse files
committed
docs: improve contributor experience with setup guide and enhanced gitignore
1 parent 3d3c6c0 commit 5f0cb35

File tree

3 files changed

+138
-0
lines changed

3 files changed

+138
-0
lines changed

.gitignore

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,37 @@ docs-internal-data/
5656

5757
# For intermediate data (like scraping for Elasticsearch indexing)
5858
tmp/
59+
60+
# Additional common files to ignore
61+
*.log
62+
*.pid
63+
*.seed
64+
*.pid.lock
65+
.npm
66+
.nyc_output
67+
.grunt
68+
bower_components
69+
.lock-wscript
70+
build/Release
71+
.coverage
72+
.nyc_output
73+
.cache
74+
.parcel-cache
75+
.next
76+
out
77+
dist
78+
.nuxt
79+
.vuepress/dist
80+
.serverless
81+
.fusebox
82+
.dynamodb
83+
.tern-port
84+
85+
# OS generated files
86+
.DS_Store
87+
.DS_Store?
88+
._*
89+
.Spotlight-V100
90+
.Trashes
91+
ehthumbs.db
92+
Thumbs.db

CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Contributing to GitHub Docs
2+
3+
Thank you for your interest in contributing to GitHub Docs! 🎉
4+
5+
## Quick Start for Contributors
6+
7+
### First-time Setup
8+
9+
1. **Fork and clone the repository**
10+
```bash
11+
git clone https://github.com/YOUR-USERNAME/docs.git
12+
cd docs
13+
```
14+
15+
2. **Install dependencies**
16+
```bash
17+
npm install
18+
```
19+
20+
3. **Start the development server**
21+
```bash
22+
npm run dev
23+
```
24+
25+
### Making Changes
26+
27+
1. **Create a new branch**
28+
```bash
29+
git checkout -b your-feature-branch
30+
```
31+
32+
2. **Make your changes**
33+
- Edit content in the `content/` directory
34+
- Test your changes locally with `npm run dev`
35+
36+
3. **Test your changes**
37+
```bash
38+
npm test
39+
npm run lint
40+
```
41+
42+
4. **Commit and push**
43+
```bash
44+
git add .
45+
git commit -m "Brief description of your changes"
46+
git push origin your-feature-branch
47+
```
48+
49+
5. **Create a Pull Request**
50+
- Go to GitHub and create a PR from your fork
51+
52+
## Easy First Contributions
53+
54+
- Fix typos in documentation
55+
- Improve code examples
56+
- Add missing installation steps
57+
- Update outdated links
58+
- Improve formatting and readability
59+
60+
## Need Help?
61+
62+
- Check the detailed [contributing guide](contributing/README.md)
63+
- Browse [help wanted issues](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
64+
- Read the [content style guide](contributing/content-style-guide.md)
65+
66+
## Code of Conduct
67+
68+
Please note that this project is released with a [Code of Conduct](.github/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,42 @@ This repository contains the documentation website code and Markdown source file
55

66
GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.
77

8+
## Prerequisites
9+
10+
- **Node.js**: Version 20 or 22 (see [engines](package.json) in package.json)
11+
- **npm**: Comes with Node.js
12+
- **Git**: For version control
13+
14+
## Quick Start
15+
16+
### Installation
17+
18+
1. **Clone the repository**
19+
```bash
20+
git clone https://github.com/github/docs.git
21+
cd docs
22+
```
23+
24+
2. **Install dependencies**
25+
```bash
26+
npm install
27+
```
28+
29+
3. **Start the development server**
30+
```bash
31+
npm run dev
32+
```
33+
The site will be available at `http://localhost:4000`
34+
35+
### Available Scripts
36+
37+
- `npm run dev` - Start development server with English content only
38+
- `npm run start-all-languages` - Start server with all language versions
39+
- `npm run build` - Build the production version
40+
- `npm test` - Run the test suite
41+
- `npm run lint` - Check code style and formatting
42+
- `npm run prettier` - Format code automatically
43+
844
Use the table of contents icon <img alt="Table of contents icon" src="./contributing/images/table-of-contents.png" width="25" height="25" /> on the top right corner of this document to navigate to a specific section quickly.
945

1046
## Contributing

0 commit comments

Comments
 (0)