Skip to content

Commit

Permalink
Use bash script markdown in CONTRIBUTING.md (#6530)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?
#6528 

## Description of the changes
changed some git commands' format from 'code' to 'bash script' 
## How was this change tested?
now you can just click and copy shell commands
## Checklist
- [x] I have read
https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md
- [x] I have signed all commits
- [x] I have added unit tests for the new functionality
- [x] I have run lint and test steps successfully
  - for `jaeger`: `make lint test`
  - for `jaeger-ui`: `npm run lint` and `npm run test`

---------

Signed-off-by: MAX-786 <[email protected]>
Signed-off-by: Mohammad K. Hussain <[email protected]>
Co-authored-by: Yuri Shkuro <[email protected]>
  • Loading branch information
MAX-786 and yurishkuro authored Jan 11, 2025
1 parent 1379a97 commit 89c4ee4
Showing 1 changed file with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions CONTRIBUTING_GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,36 @@ If you are new to GitHub's contribution workflow, we recommend the following set
* Go to the respective Jaeger repo on GitHub and create a fork using the button at the top. Select a destination org where you have write permissions (usually it is your personal "org").
* Clone the fork into your workspace.
* (Recommended): register upstream repo as remote
* After you clone your forked repo, `git remote -v` will show `origin`, e.g. `origin [email protected]:{username}/jaeger.git`
* Add `upstream` remote: `git remote add upstream [email protected]:jaegertracing/jaeger.git`
* Fetch it: `git fetch upstream main`
* Repoint your main branch: `git branch --set-upstream-to=upstream/main main`
* After you clone your forked repo, running below command
```bash
git remote -v
```
will show `origin`, e.g. `origin [email protected]:{username}/jaeger.git`
* Add `upstream` remote:
```bash
git remote add upstream [email protected]:jaegertracing/jaeger.git
```
* Fetch it:
```bash
git fetch upstream main
```
* Repoint your main branch:
```bash
git branch --set-upstream-to=upstream/main main
```
* With this setup, you will not need to keep your main branch in the fork in sync with the upstream repo.

Once you're ready to make changes:
* Create a new local branch (DO NOT make changes to `main`, it will cause CI errors).
* Commit your changes, making sure **each commit is signed**, e.g. `git commit -s ...` ([see below](#certificate-of-origin---sign-your-work)).
* Commit your changes, making sure **each commit is signed** ([see below](#certificate-of-origin---sign-your-work)):
```bash
git commit -s -m "Your commit message"
```
* You do not need to squash the commits, it will happen once the PR is merged into the official repo (but each individual commit must be signed).
* When satisfied, push the changes. Git will likely ask for upstream destination: `git push --set-upstream origin {branch-name}`.
* When satisfied, push the changes. Git will likely ask for upstream destination, so you push commits like this:
```bash
git push --set-upstream origin {branch-name}
```
* After you push, look for the output, it usually contains a URL to create a pull request.
Each PR should have:
Expand Down

0 comments on commit 89c4ee4

Please sign in to comment.