Skip to content
This repository has been archived by the owner on Jun 5, 2023. It is now read-only.

Consolidate README information #83

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

Tacktician
Copy link
Contributor

Thanks for contributing to the saucectl project!
A PR well described will help maintainers to quickly review and merge it

Before submitting your PR, please check our contributing
guidelines, applied for this repository. Avoid large PRs, help reviewers by making them as simple
and short as possible.

Description

  • Consolidated README informaton
  • Provided deep links to documentation
  • Created a TOC for nav puproses

Motivation and Context

  • Remove duplicate information
  • Single source important, detailed information.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

specify it through:

```shell script
saucectl run -c ./path/to/config.yml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spider-sauce in regards to the docs do we want to show our examples with the long version name of the flag?

saucectl run -c ./path/to/config.yml

vs

saucectl run --config ./path/to/config.yml

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants