Skip to content

Commit

Permalink
Updated instructions for contributions to dev branch
Browse files Browse the repository at this point in the history
  • Loading branch information
profvjreddi committed May 17, 2024
1 parent 199306e commit dc8d76f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit dc8d76f

Please sign in to comment.