Skip to content

Updating docs for links to issues and coding guidelines closes #13 #124

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

Merged
merged 10 commits into from
Jun 17, 2025

Conversation

SQLDBAWithABeard
Copy link
Contributor

Pull Request

Pull Request (PR) description

This PR is solely for documentation updates to ease future PRs by providing links to guidelines that can be used by contributors to create PRs that will be consistent with the repo.

THERE ARE NO CODE CHANGES

Task list

  • [ X] The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs.
  • [ X] Local clean build passes without issue or fail tests (build.ps1 -ResolveDependency -Tasks build, test).
  • [ X] Documentation added/updated (where applicable).
  • [ X] Code follows the contribution guidelines.

Improved the documentation by adding links to coding guidelines, bug reporting, feature requests, and discussion sections. Clarified the Pull Request workflow and bug reporting process to assist contributors in navigating the project more effectively.

Thank you for your contributions!
This update enhances the Pull Request template by specifying that titles should prepend with the [DscResourceName] for DSC resource-specific PRs. Additionally, it emphasizes the importance of submitting atomic PRs and following contribution guidelines.

Thank you!
Copy link

github-actions bot commented Jun 14, 2025

Linux Test Results

4 572 tests   4 571 ✅  42s ⏱️
  407 suites      1 💤
    1 files        0 ❌

Results for commit d4b542a.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jun 14, 2025

WinPS51 Test Results

4 777 tests   4 776 ✅  51s ⏱️
  408 suites      1 💤
    1 files        0 ❌

Results for commit d4b542a.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jun 14, 2025

WinPS71 Test Results

4 777 tests   4 776 ✅  51s ⏱️
  408 suites      1 💤
    1 files        0 ❌

Results for commit d4b542a.

♻️ This comment has been updated with latest results.

@SQLDBAWithABeard SQLDBAWithABeard added the documentation Improvements or additions to documentation label Jun 15, 2025
@SQLDBAWithABeard SQLDBAWithABeard changed the title Updating docs for links to issues and coding guidelines Updating docs for links to issues and coding guidelines closes #13 Jun 15, 2025
Copy link
Contributor

@jpomfret jpomfret left a comment

Choose a reason for hiding this comment

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

@SQLDBAWithABeard - good adds, couple of wording change ideas but nothing major. Thanks for adding to these!

SQLDBAWithABeard and others added 2 commits June 16, 2025 08:14
Co-authored-by: Jess Pomfret <jpomfret7@gmail.com>
Signed-off-by: Rob Sewell <mrrobsewell@outlook.com>
Co-authored-by: Jess Pomfret <jpomfret7@gmail.com>
Signed-off-by: Rob Sewell <mrrobsewell@outlook.com>
Copy link
Contributor

@NowinskiK NowinskiK left a comment

Choose a reason for hiding this comment

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

I added few cosmetic suggestions.

@NowinskiK NowinskiK requested a review from tiagobalabuch June 16, 2025 13:44
SQLDBAWithABeard and others added 4 commits June 16, 2025 15:01
Co-authored-by: Kamil Nowinski <kamil@nowinski.net>
Signed-off-by: Rob Sewell <mrrobsewell@outlook.com>
Co-authored-by: Kamil Nowinski <kamil@nowinski.net>
Signed-off-by: Rob Sewell <mrrobsewell@outlook.com>
Co-authored-by: Kamil Nowinski <kamil@nowinski.net>
Signed-off-by: Rob Sewell <mrrobsewell@outlook.com>
Co-authored-by: Kamil Nowinski <kamil@nowinski.net>
Signed-off-by: Rob Sewell <mrrobsewell@outlook.com>
@jpomfret
Copy link
Contributor

@NowinskiK - you happy here? looks like requested changes have been addressed? Cheers

Copy link
Contributor

@NowinskiK NowinskiK left a comment

Choose a reason for hiding this comment

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

I updated Standards page, which is referred by CONTRIBUTING page (please take a look), so I'm happy now with these changes here. Thanks!

@SQLDBAWithABeard SQLDBAWithABeard merged commit 0d36065 into develop Jun 17, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants