Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contributing to llm-d Website

Thank you for your interest in contributing to the llm-d website! This project adheres to the llm-d [Contributing Guidelines](https://github.com/llm-d/llm-d/blob/dev/CONTRIBUTING.md).
56 changes: 39 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ If you spot any errors or ommisions in the site, please open an issue at [github
3. Fork the website repo and deploy a preview version of your proposed change for reviewers to check. This will make obvious any missed links from step 2




### Installation

```
Expand All @@ -29,26 +27,50 @@ $ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

<!-- ### Build
### Making Changes

```
$ yarn build
```
1. **Fork the Repository**
- Click the "Fork" button on the [llm-d.github.io](https://github.com/llm-d/llm-d.github.io) repository
- Clone your fork locally: `git clone https://github.com/YOUR-USERNAME/llm-d.github.io.git`

This command generates static content into the `build` directory and can be served using any static contents hosting service.
2. **Create a Branch**
- Create a new branch for your changes: `git checkout -b feature/your-feature-name`
- Make your changes locally

### Deployment
3. **Commit Your Changes**
- Stage your changes: `git add .`
- Commit with sign-off: `git commit -s -m "Your commit message"`
- Push to your fork: `git push origin feature/your-feature-name`

Using SSH:
4. **Open a Pull Request**
- Go to your fork on GitHub
- Click "New Pull Request"
- Select the main branch of llm-d/llm-d.github.io as the base
- Fill out the pull request template with details about your changes

```
$ USE_SSH=true yarn deploy
```
### Pull Request Preview

Not using SSH:
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.

```
$ GIT_USER=<Your GitHub username> yarn deploy
```
- The preview URL will be posted as a comment on your pull request
- The preview site will be automatically updated as you push new commits
- The preview will be removed when the pull request is closed

### Code Review Requirements

- **All code changes** must be submitted as pull requests (no direct pushes)
- **All changes** must be reviewed and approved by a maintainer
- **All changes** must pass automated checks and tests
- **Commit messages** should have:
- Short, descriptive titles
- Description of why the change was needed
- Enough detail for someone reviewing git history to understand the scope
- **DCO Sign-off**: All commits must include a valid DCO sign-off line (`Signed-off-by: Name <[email protected]>`)
- Add automatically with `git commit -s`
- See [PR_SIGNOFF.md](https://github.com/llm-d/llm-d/blob/dev/PR_SIGNOFF.md) for configuration details
- Required for all contributions per [Developer Certificate of Origin](https://developercertificate.org/)

## Questions?

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. -->
- For immediate help: Join [llm-d.slack.com](https://llm-d.slack.com) -> [Invite Link](https://inviter.co/llm-d-slack)
- For issues: Create an issue in [llm-d/llm-d.github.io](https://github.com/llm-d/llm-d.github.io)