Skip to content

Commit 67c294c

Browse files
committed
Add CONTRIBUTING.md file with guidelines for project contributions
Signed-off-by: Pete Cheslock <[email protected]>
1 parent ab49aca commit 67c294c

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

CONTRIBUTING.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing to llm-d Website
2+
3+
Thank you for your interest in contributing to the llm-d website! This document outlines the guidelines and processes for contributing to the project.
4+
5+
## Code of Conduct
6+
7+
This project adheres to the llm-d [Code of Conduct and Covenant](https://github.com/llm-d/llm-d/blob/dev/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
8+
9+
## Getting Started
10+
11+
### Community
12+
13+
- **Slack**: Join our public discussion at [llm-d.slack.com](https://llm-d.slack.com) for immediate response and collaboration
14+
- **Join Slack**: You can join the [llm-d Slack at Inviter](https://inviter.co/llm-d-slack)
15+
- **Code**: Hosted in the [llm-d](https://github.com/llm-d) GitHub organization
16+
- **Issues**: Website-related bugs or issues should be reported in [llm-d/llm-d.github.io](https://github.com/llm-d/llm-d.github.io)
17+
18+
## Contributing Process
19+
20+
### Making Changes
21+
22+
1. **Fork the Repository**
23+
- Click the "Fork" button on the [llm-d.github.io](https://github.com/llm-d/llm-d.github.io) repository
24+
- Clone your fork locally: `git clone https://github.com/YOUR-USERNAME/llm-d.github.io.git`
25+
26+
2. **Create a Branch**
27+
- Create a new branch for your changes: `git checkout -b feature/your-feature-name`
28+
- Make your changes locally
29+
30+
3. **Commit Your Changes**
31+
- Stage your changes: `git add .`
32+
- Commit with sign-off: `git commit -s -m "Your commit message"`
33+
- Push to your fork: `git push origin feature/your-feature-name`
34+
35+
4. **Open a Pull Request**
36+
- Go to your fork on GitHub
37+
- Click "New Pull Request"
38+
- Select the main branch of llm-d/llm-d.github.io as the base
39+
- Fill out the pull request template with details about your changes
40+
41+
### Pull Request Preview
42+
43+
When you open a pull request, a preview of your changes will be automatically generated and deployed. This allows reviewers to see your changes in a live environment before they are merged into the main website.
44+
45+
- The preview URL will be posted as a comment on your pull request
46+
- The preview site will be automatically updated as you push new commits
47+
- The preview will be removed when the pull request is closed
48+
49+
### Code Review Requirements
50+
51+
- **All code changes** must be submitted as pull requests (no direct pushes)
52+
- **All changes** must be reviewed and approved by a maintainer
53+
- **All changes** must pass automated checks and tests
54+
- **Commit messages** should have:
55+
- Short, descriptive titles
56+
- Description of why the change was needed
57+
- Enough detail for someone reviewing git history to understand the scope
58+
- **DCO Sign-off**: All commits must include a valid DCO sign-off line (`Signed-off-by: Name <[email protected]>`)
59+
- Add automatically with `git commit -s`
60+
- See [PR_SIGNOFF.md](https://github.com/llm-d/llm-d/blob/dev/PR_SIGNOFF.md) for configuration details
61+
- Required for all contributions per [Developer Certificate of Origin](https://developercertificate.org/)
62+
63+
## Questions?
64+
65+
- For immediate help: Join [llm-d.slack.com](https://llm-d.slack.com)
66+
- For issues: Create an issue in [llm-d/llm-d.github.io](https://github.com/llm-d/llm-d.github.io)

0 commit comments

Comments
 (0)