Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Policy cmdlets for mercury #382

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

Conversation

siddharth7
Copy link

Description


This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

General Guidelines

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
  • The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • Pull request includes test coverage for the included changes.
  • PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

  • New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
  • Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThrough parameter.

Cmdlet Parameter Guidelines

  • Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
  • Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

@siddharth7 siddharth7 force-pushed the users/sisi/mercury_policy branch 3 times, most recently from af5c8d9 to 1004233 Compare November 29, 2018 08:25
@siddharth7 siddharth7 requested a review from shrac November 30, 2018 09:51
@siddharth7 siddharth7 force-pushed the users/sisi/mercury_policy branch 2 times, most recently from e40bec6 to e8fde85 Compare December 20, 2018 07:23
@siddharth7 siddharth7 force-pushed the users/sisi/mercury_policy branch from e8fde85 to 34db583 Compare December 26, 2018 07:53
/// <summary>
/// Is compression enabled
/// </summary>
public bool? IsCompression { get; set; }
Copy link
Author

Choose a reason for hiding this comment

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

Going forward we will have only one of these, resolve it now to avoid breaking changes

{
SettingsBase settings = new SettingsBase();
settings.IsCompression = policySettings.IsCompression;
settings.Issqlcompression = policySettings.Issqlcompression;
Copy link
Author

Choose a reason for hiding this comment

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

should we keep only one of them?

@siddharth7 siddharth7 force-pushed the users/sisi/mercury_policy branch from 34db583 to 36511b6 Compare January 8, 2019 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant