Skip to content

Conversation

@mikefrobbins
Copy link
Contributor

Description

Fixes #14021 - Updated contribution guide

Checklist

  • SHOULD select appropriate branch. Cmdlets from Autorest.PowerShell should go to generation branch.
  • SHOULD make the title of PR clear and informative, and in the present imperative tense.
  • SHOULD update ChangeLog.md file(s) appropriately
    • For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
    • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense. Add changelog in description section if PR goes into generation branch.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD have approved design review for the changes in this repository (Microsoft internal only) with following situations
    • Create new module from scratch
    • Create new resource types which are not easy to conform to Azure PowerShell Design Guidelines
    • Create new resource type which name doesn't use module name as prefix
    • Have design question before implementation
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT introduce breaking changes in Az minor release except preview version.
  • SHOULD NOT adjust version of module manually in pull request

Copy link
Contributor

@dcaro dcaro left a comment

Choose a reason for hiding this comment

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

Thanks for this change, I suggest that we add some content about the type of contribution can be made so that everyone feel that they can contribute regardless of their level. It can be a typo to fix to providing new examples to adding parameters / cmdlets.
I recommend that we add a page on how to contribute to the reference docs (including examples).
@dingmeng-xue do we still want to point to those articles? Because we are now looking more at generation code, I would like to see how to contribute to modules generated.

@mikefrobbins
Copy link
Contributor Author

@dcaro, Please merge these changes and we'll iterate from there. The existing documentation is completely outdated pointing to issues template that no longer exist and referencing the master branch instead of main.

I'll revisit and submit the types of contributions that can be made. Contributing to the reference docs should be a contribution guide in the azure-docs-powershell repo. We can add a link in this guide pointing to it once it's been created.

Copy link
Contributor

@dcaro dcaro left a comment

Choose a reason for hiding this comment

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

Let's merge and review later

@dcaro dcaro merged commit 30ed4a8 into Azure:main Oct 31, 2022
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.

Update readme and contributing guide

2 participants