Skip to content

Latest commit

 

History

History
66 lines (37 loc) · 3.38 KB

README.md

File metadata and controls

66 lines (37 loc) · 3.38 KB
Raw

ACCESS-Hive

ACCESS-Hive Badge github-contributors forum-users Link Check

Documentation hub for the Earth System models, ACCESS, and their community.

This repository uses Material for MkDocs to build the website which accessible at this URL:

https://access-hive.org.au/

If you wish to add documentation to the ACCESS-Hive website see the contribution guide for instructions.

How to Contribute [Draft]

  • Pull the latest version of development branch locally by using the following commands:

    Fetch the remote branches from github:

    git fetch

    On terminal, switch to the development branch locally using the command:

    git switch development

    Pull the latest changes from remote development branch locally:

    git pull

  • Once the latest version of development branch is pulled locally, use the following two commands to create the new branch and push it to github respectively:

    git checkout -b dev/jasmeen/legacy-release

    git push --set-upstream origin dev/jasmeen/legacy-release

  • Prefixing the branch name with dev/jasmeen might be used as an indicator that this needs to merged in the development branch of access-hive (staging branch deployed on https://access-hive.org.au/development_site/), and not the main branch.

  • Work locally on the branch dev/jasmeen/legacy-release, and push the commits using the commands:

    git add .

    git commit -m "First commit"

    git push

  • While working locally on the branch, please make sure to regularly pull changes from remote development branch into your branch, using the command:

    git pull origin development

    This would make sure that the local branch dev/jasmeen/legacy-release is always in sync with the latest changes in the remote development branch.

  • Once the changes on the local branch dev/jasmeen/legacy-release is ready to be integrated with the development branch, create a pull request on github by changing the base to development. (Please find the below screenshot). This would create a pr on the development branch.

    Screenshot 2023-06-02 at 2 05 13 pm

  • When creating a pull request (PR) please also assign a reviewer to avoid delays. For technical content please assign an expert reviewer.

License

The ACCESS-Hive site is covered by the CC-BY 4.0 license.

However, the material linked to from ACCESS-Hive is covered by various licensing agreements. Our users should directly refer to the terms and conditions of any material they are using to understand their rights and responsibilities.