Skip to main content
Version: 0.16.8

Contributing with GitHub

To avoid forking the repository, Great Expectations recommends using the GitHub Markdown editor to edit documentation.

  1. Open a browser and go to the GitHub Great Expectations docs repository.

  2. Go to the topic file you want to edit. The topic URL contains the path to each topic file. For example, the path for this topic is https://docs.greatexpectations.io/docs/contributing/contributing_github. The URL indicates the topic is located in the contributing folder, and it's named contributing_github.

  3. Click the file and then click Edit this file.

  4. Add your edits. See the Great Expectations Style Guide for formatting recommendations.

  5. Optional. Click the Preview tab to preview your changes.

  6. When you’ve completed your edits, scroll down to the Propose changes section and add a meaningful commit message and an explanation of what you changed and why.

  7. Select Create a new branch for this commit and start a pull request. Accept the default name for the branch, or enter a new one.

  8. Click Propose changes.

    If this is your first Great Expectations documentation contribution, you'll be prompted to complete the Contributor License Agreement (CLA). Complete the CLA and add @cla-bot check as a comment to the pull request (PR) to indicate that you’ve completed it.

  9. Wait for the Continuous Integration (CI) checks to complete and then correct any syntax or formatting issues.

    A Great Expectations team member reviews, approves, and merges your PR. Depending on your GitHub notification settings, you'll be notified when there are comments or when your changes are successfully merged.