Skip to content

Commit

Permalink
Fixed warning messages on README to use github blockquotes (https://g…
Browse files Browse the repository at this point in the history
…ithub.com/orgs/community/discussions/16925).

Commit issued without a PR.
  • Loading branch information
atteggiani committed Feb 3, 2025
1 parent 25c134f commit 69289b2
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ The suggested workflow for a contribution on the ACCESS-Hive Docs is detailed be
git push
```
> **Tip**: When you push your new `git` branch to the remote for the first time, you will need to set its upstream with:
> [!TIP]
> When you push your new `git` branch to the remote for the first time, you will need to set its upstream with:
> ```
> git push --set-upstream origin jasmeen/improve-how-to-contribute-812
> ```
Expand All @@ -77,16 +78,18 @@ The suggested workflow for a contribution on the ACCESS-Hive Docs is detailed be
git rebase origin/development jasmeen/improve-how-to-contribute-812
```
> **Warning:** After rebasing, you might have to resolve conflicts.
> Also, to push commits of a local branch after rebasing you might need to use `git push --force-with-lease` (`--force-with-lease` is a safer alternative to `--force`).
> For these reasons, always use `git rebase` carefully. Don't hesitate to have a chat with the Hive Docs team if unsure :)
> [!WARNING]
> After rebasing, you might have to resolve conflicts.
> Also, to push commits of a local branch after rebasing you might need to use `git push --force-with-lease` (`--force-with-lease` is a safer alternative to `--force`).
> For these reasons, always use `git rebase` carefully. Don't hesitate to have a chat with the Hive Docs team if unsure :)
6. **Open a Pull Request**
Once you are happy with your contribution, [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to have it reviewed by the ACCESS-Hive Docs team.
Feel free to assign `ACCESS-NRI/WebOps` team as reviewers.
> **Note**: The ACCESS-Hive Docs repo's default branch is `development`. The `main` branch is automatically updated daily by merging the `development` branch.
> [!IMPORTANT]
> The ACCESS-Hive Docs repo's default branch is `development`. The `main` branch is automatically updated daily by merging the `development` branch.
## Styling guidelines for developers
Expand Down

0 comments on commit 69289b2

Please sign in to comment.