github-starred/cs249r_book
2
0
Fork 0
mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-03-12 02:06:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated instructions for contributions to dev branch

Browse Source
This commit is contained in:
Vijay Janapa Reddi
2024-05-17 10:21:51 -07:00
parent 199306e26b
commit dc8d76ffeb
2 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -29,6 +29,8 @@ into `gh-pages`.
You can view the book's website
at: [https://harvard-edge.github.io/cs249r_book/](https://harvard-edge.github.io/cs249r_book/)
The most recent changes are staged at: [https://harvard-edge.github.io/cs249r_book_dev/](https://harvard-edge.github.io/cs249r_book_dev/)
---
## Local Rendering

2
contribute.md
View File

@@ -80,6 +80,8 @@ git push origin your-branch-name
### Open a Pull Request (PR)
Please submit the PRs to the `dev` branch, not `main`.
Open a Pull Request (PR) to merge your changes to the upstream repository. Please add a brief description of your contribution to the PR. Please include the issue number in the description. For example, `Fix typo in the documentation (issue #14)`.
Opening an early PR is encouraged. This will allow us to provide feedback on your contribution and help you improve it. Moreover, Github Actions will run on your PR and will generate the book, so you can download the book and make sure that your contribution is rendered correctly.