Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 2.34 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

  • Configure name and email in git:

    git config --global user.name "Your Name"
    git config --global user.email "youremail@yourdomain.com"
    
  • Fork this repo

  • In your fork, create a branch for your feature

    git checkout -b add-test-ods-542-alerts

  • Develop your feature and create a git commit:

    • Before committing the code, verify that it is formatted following the ODS-CI Robot Framework Style Guide (see how )

    • Add your changes to the commit

      git add tests/Tests/200__monitor_and_manage/200__metrics/203__alerts.robot
      
    • Sign off your commit using the -s, --signoff option. Write a good commit message (see How to Write a Git Commit Message)

     git commit -s -m "Add alerts tests"
    
  • Create a personal access token in Github to be able to push your changes

  • Push your changes: git push

  • Send a PR to ods-ci using GitHub's web interface

  • If the PR can't be merged, rebase your branch to master:

    git remote add upstream https://github.com/red-hat-data-services/ods-ci
    git fetch upstream
    git checkout add-test-ods-542-alerts
    git rebase upstream/master
    git push -f
    
  • Test your PR in Jenkins using the rhods-ci-pr-test pipeline

  • Once finished, add a comment to the PR with the test run results, and a link like in the example below and add the label Verified to the PR using GitHub interface:

    https://opendatascience-jenkins-csb-rhods.apps.ocp-c1.prod.psi.redhat.com/job/rhods-ci-pr-test/49/console
    
    Result: passing except for the Git plugin missing from the minimal image
    
  • Participate in the feedback of your PR until is merged