Skip to content

Commit ba6a658

Browse files
committed
Added small tweaks for clarity
1 parent 11a98d6 commit ba6a658

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/about/contribute.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -192,15 +192,11 @@ Once, you have committed your changes, push your branch to GitHub. The first tim
192192
git push --set-upstream origin your-branch-name
193193
```
194194

195-
The --set-upstream option links your local branch to the branch on GitHub. After this you can any future commits on the same branch with:
195+
The `--set-upstream` option links your local branch to the branch on GitHub. After this you can any future commits on the same branch with:
196196

197197
```
198198
git push
199199
```
200-
or
201-
```
202-
git push origin your-branch-name
203-
```
204200

205201
#### Step 9: Open a pull request
206202
After pushing your branch to remote, [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) using the following steps:
@@ -225,7 +221,7 @@ After you open a pull request, a **preview version** of the documentation is aut
225221
The pull request preview shows how your changes will appear before they are added to the public website, making it a great way to catch formatting or rendering issues.
226222

227223

228-
## Checklist
224+
## Best Practices
229225
??? info "Creating issues"
230226
Creating clear and well-labelled issues helps contributors to quickly understand the type, purpose, and urgency of a task.
231227

@@ -271,5 +267,9 @@ After you open a pull request, a **preview version** of the documentation is aut
271267
- Check GitHub CI is passing all checks.
272268

273269
## Need help?
274-
1. For any questions, [create a help request on the ACCESS-Hive Forum](https://forum.access-hive.org.au/new-topic?&body=%3Cdiv%20data-theme-toc%3D%22true%22%3E%3C%2Fdiv%3E%0A%0A%3C!--%20These%20are%20comments%20and%20not%20visible%20once%20you%20post.%20Ignore%20or%20delete%20sections%20if%20not%20relevant%20--%3E%0A%0A%3C!--%20Choose%20an%20appropriate%20category.%20If%20not%20sure%2C%20leave%20as%20General%20--%3E%0A%0A%23%23%20Description%20of%20request%3A%0A%0A%23%23%20Environment%3A%0A%0A%3C!--%20NCI%3F%20ARE%3F%20Gadi%20login%20node%3F%20PBS%20job%3F%20--%3E%0A%0A%3C!--%20List%20software%20versions%20--%3E%0A%0A%23%23%20What%20executed%3A%0A%0A%3C!--%20Copy%20and%20paste%20any%20commands%20and%20output%20in%20a%20code%20block%20--%3E%0A%3C!--%20For%20code%20you%20are%20writing%2C%20prepare%20a%20minimal%20reproducible%20example%20(https%3A%2F%2Fforum.access-hive.org.au%2Fdocs%3Ftopic%3D843)%20--%3E%0A%0A%23%23%20Actual%20results%3A%0A%0A%3C!--%20Copy%20full%20error%20messages%20--%3E%0A%0A%23%23%20Expected%20results%3A%0A%0A%23%23%20Additional%20info%3A&category_id=4&tags=help)!
275-
2. For a more in-depth guide to using GitHub and git, see the [Project Pythia "Getting Started with GitHub" tutorial](https://foundations.projectpythia.org/foundations/getting-started-github/).
270+
1. For any questions, [create a help request on the ACCESS-Hive Forum](https://forum.access-hive.org.au/new-topic?&body=%3Cdiv%20data-theme-toc%3D%22true%22%3E%3C%2Fdiv%3E%0A%0A%3C!--%20These%20are%20comments%20and%20not%20visible%20once%20you%20post.%20Ignore%20or%20delete%20sections%20if%20not%20relevant%20--%3E%0A%0A%3C!--%20Choose%20an%20appropriate%20category.%20If%20not%20sure%2C%20leave%20as%20General%20--%3E%0A%0A%23%23%20Description%20of%20request%3A%0A%0A%23%23%20Environment%3A%0A%0A%3C!--%20NCI%3F%20ARE%3F%20Gadi%20login%20node%3F%20PBS%20job%3F%20--%3E%0A%0A%3C!--%20List%20software%20versions%20--%3E%0A%0A%23%23%20What%20executed%3A%0A%0A%3C!--%20Copy%20and%20paste%20any%20commands%20and%20output%20in%20a%20code%20block%20--%3E%0A%3C!--%20For%20code%20you%20are%20writing%2C%20prepare%20a%20minimal%20reproducible%20example%20(https%3A%2F%2Fforum.access-hive.org.au%2Fdocs%3Ftopic%3D843)%20--%3E%0A%0A%23%23%20Actual%20results%3A%0A%0A%3C!--%20Copy%20full%20error%20messages%20--%3E%0A%0A%23%23%20Expected%20results%3A%0A%0A%23%23%20Additional%20info%3A&category_id=4&tags=help).
271+
272+
## Further Reading
273+
- For official GitHub documentation, see [GitHub Docs](https://docs.github.com/en/get-started).
274+
- For a more detailed, beginner-friendly introduction to Git and GitHub, see [Project Pythia - Getting Started with GitHub tutorial](https://foundations.projectpythia.org/foundations/getting-started-github/).
275+

0 commit comments

Comments
 (0)