Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 1.79 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 "[email protected]"
    
  • Fork this repo

  • In your fork, create a branch for your feature

    git checkout -b add-contributing-section-to-readme

  • Develop your feature and create a git commit:

    • Add your changes to the commit

      git add README.md

    • 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 Contributing section to Readme"

  • 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

  • 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:

    https://opendatascience-jenkins-csb-rhods.apps.ocp4.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