mirror of
https://github.com/openhwgroup/cvw
synced 2025-02-11 06:05:49 +00:00
54 lines
2.9 KiB
Plaintext
54 lines
2.9 KiB
Plaintext
###########################################
|
|
## A component of the CORE-V-WALLY configurable RISC-V project.
|
|
##
|
|
## Copyright (C) 2021-23 Harvey Mudd College & Oklahoma State University
|
|
##
|
|
## SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
|
|
##
|
|
## Licensed under the Solderpad Hardware License v 2.1 (the “License”); you may not use this file
|
|
## except in compliance with the License, or, at your option, the Apache License version 2.0. You
|
|
## may obtain a copy of the License at
|
|
##
|
|
## https://solderpad.org/licenses/SHL-2.1/
|
|
##
|
|
## Unless required by applicable law or agreed to in writing, any work distributed under the
|
|
## License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
|
## either express or implied. See the License for the specific language governing permissions
|
|
## and limitations under the License.
|
|
################################################################################################
|
|
|
|
Setup
|
|
1. goto github and fork openhwgroup/cvw.git
|
|
2. clone: git clone --recurse-submodules git@ross144/cvw.git
|
|
3. git remote add upstream https://github.com/openhwgroup/cvw.git
|
|
4. install gh (github command line interface)
|
|
type -p curl >/dev/null || sudo apt install curl -y
|
|
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
|
|
&& sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
|
|
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
|
|
&& sudo apt update \
|
|
&& sudo apt install gh -y
|
|
|
|
Once per session (This authorizes gh to use your github account)
|
|
1. gh auth login
|
|
2. Use ssh and point to your public key
|
|
3. Copy one-time code from terminal to browser
|
|
|
|
Fetch upstream and sync fork
|
|
1. git pull upstream main # fetch and merge the upstream openhwgroup/cvw into your local clone
|
|
2. git push # pushes changes back to your fork. Now all three should be in sync
|
|
|
|
Create pull request
|
|
1. git pull upstream main # fetch and merge the upstream openhwgroup/cvw into your local clone
|
|
3. git push # pushes changes back to your fork. Now all three should be in sync
|
|
4. gh pr create # Create a pull request.
|
|
5. Must include a title and strongly encourage a body message explaining your changes.
|
|
6. Wait for pull request to be approved, rejected, or needs changes.
|
|
7. Finish by fetching the upstream and pushing back to your fork.
|
|
1. git pull upstream main # fetch and merge the upstream openhwgroup/cvw into your local clone
|
|
3. git push # sync your fork with the upstream and clone
|
|
|
|
|
|
If the pull request need changes, modify accordingly, commit, and push changes back to the fork.
|
|
The pull request will automatically update.
|