You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add CONTRIBUTING.md file with guidelines for project contributions (#52)
* Add CONTRIBUTING.md file with guidelines for project contributions
Signed-off-by: Pete Cheslock <[email protected]>
* Refactor contributing guidelines in CONTRIBUTING.md and README.md
- Streamlined the contributing process by consolidating instructions and removing outdated sections.
- Updated the pull request preview and code review requirements for clarity.
- Enhanced links for community support and issue reporting.
Signed-off-by: Pete Cheslock <[email protected]>
---------
Signed-off-by: Pete Cheslock <[email protected]>
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).
Copy file name to clipboardExpand all lines: README.md
+39-17Lines changed: 39 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,6 @@ If you spot any errors or ommisions in the site, please open an issue at [github
13
13
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
14
14
15
15
16
-
17
-
18
16
### Installation
19
17
20
18
```
@@ -29,26 +27,50 @@ $ npm start
29
27
30
28
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
31
29
32
-
<!--### Build
30
+
### Making Changes
33
31
34
-
```
35
-
$ yarn build
36
-
```
32
+
1.**Fork the Repository**
33
+
- Click the "Fork" button on the [llm-d.github.io](https://github.com/llm-d/llm-d.github.io) repository
34
+
- Clone your fork locally: `git clone https://github.com/YOUR-USERNAME/llm-d.github.io.git`
37
35
38
-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
36
+
2.**Create a Branch**
37
+
- Create a new branch for your changes: `git checkout -b feature/your-feature-name`
- Push to your fork: `git push origin feature/your-feature-name`
41
44
42
-
Using SSH:
45
+
4.**Open a Pull Request**
46
+
- Go to your fork on GitHub
47
+
- Click "New Pull Request"
48
+
- Select the main branch of llm-d/llm-d.github.io as the base
49
+
- Fill out the pull request template with details about your changes
43
50
44
-
```
45
-
$ USE_SSH=true yarn deploy
46
-
```
51
+
### Pull Request Preview
47
52
48
-
Not using SSH:
53
+
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.
49
54
50
-
```
51
-
$ GIT_USER=<Your GitHub username> yarn deploy
52
-
```
55
+
- The preview URL will be posted as a comment on your pull request
56
+
- The preview site will be automatically updated as you push new commits
57
+
- The preview will be removed when the pull request is closed
58
+
59
+
### Code Review Requirements
60
+
61
+
-**All code changes** must be submitted as pull requests (no direct pushes)
62
+
-**All changes** must be reviewed and approved by a maintainer
63
+
-**All changes** must pass automated checks and tests
64
+
-**Commit messages** should have:
65
+
- Short, descriptive titles
66
+
- Description of why the change was needed
67
+
- Enough detail for someone reviewing git history to understand the scope
68
+
-**DCO Sign-off**: All commits must include a valid DCO sign-off line (`Signed-off-by: Name <[email protected]>`)
69
+
- Add automatically with `git commit -s`
70
+
- See [PR_SIGNOFF.md](https://github.com/llm-d/llm-d/blob/dev/PR_SIGNOFF.md) for configuration details
71
+
- Required for all contributions per [Developer Certificate of Origin](https://developercertificate.org/)
72
+
73
+
## Questions?
53
74
54
-
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. -->
75
+
- For immediate help: Join [llm-d.slack.com](https://llm-d.slack.com) -> [Invite Link](https://inviter.co/llm-d-slack)
76
+
- For issues: Create an issue in [llm-d/llm-d.github.io](https://github.com/llm-d/llm-d.github.io)
0 commit comments