Skip to content
Kati Lassila-Perini edited this page Jul 10, 2024 · 5 revisions

Welcome to the cloud-processing wiki!

Contributing

To contribute

  • generate a ssh key and upload it to your GitHub repository

  • clone the repository to your computer

    git clone git@github.com:cms-dpoa/cloud-processing.git
    cd cloud-processing
    
  • this is done only once when you start, but every time you come back to this area after a while, make sure you pull the eventual updates with

    git checkout main
    git pull
    
  • for code updates, first open an issue and describe what needs to be changed

  • when you start working on a feature or fix referred to in an issue, make a new branch with

    git checkout -b <your-branch-name>
    
  • update the code (or documentation) as needed

  • check the status with

    git status
    
  • add and commit the changes to your local git area (use git add . only if you are sure that all updated files should be added to the repository

    git add <the file name to be added>
    git commit -m "describe your commit, closes #<issue-number>"
    
  • push the commit to the GitHub area

    git push origin <your-branch-name>
    
  • go to the GitHub repository web area and make a pull request to the main branch

  • check the changes in the "Files changes" tab of the pull request

  • you can request someone to review the changes

  • merge the changes with "Merge"

  • delete the branch if this is the final update to address the issue

  • once the fix is merged, update the main branch of your local area with

    git checkout main
    git pull
    

Data download time and cost

Clone this wiki locally