Skip to content

Latest commit

 

History

History
96 lines (73 loc) · 5.58 KB

CONTRIBUTING.md

File metadata and controls

96 lines (73 loc) · 5.58 KB
Raw

Contributing to PowerShell Deployment (PSD)

Welcome to PSD and thank you for your interest in contributing!

There are many ways that you can contribute, beyond writing or coding. The goal of this document is to provide a high-level overview of how you can get involved and how to interact.

Contributor Agreement

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

PSD Development Tools

If you want to contribute, you'll need to download, install and configure the following tools and request access to our PSD GitHub Repo

We'll leave installation and configuration to you. As they say in mathematics classes - it should be obvious to the casual observer. :)

PSD Development and Contribution Steps

  1. Fork a copy of the FriendsOfMDT/PSD repository using your GitHub account
  2. Clone your PSD fork locally to your computer

    ProTip: You may want to clone it to your OneDrive folder so that it's available on all your shared systems.

  3. Open and edit files and scripts using Visual Studio Code
  4. Save your changes in VSC
  5. When ready to upload,
    • open GitHub Desktop and your repository
    • Update the Summary input field (lower left)
    • Update the Description input field (lower left)
    • Click on Commit to Master (lower left)
    • Click on Push origin to push your changes upstream
  6. Open GitHub to your PSD repository
    • Click on Repository -> View on GitHub
  7. Generate a Pull Reqeust
    • Click on Create Pull Request

Your submissions and contributions will be reviewed and processed by the PSD curation team. You will receive notifications in the GitHub tools as well as the email account used for GitHub.

Asking Questions

Have a question? Open an new issue using the question template and the question label. The active community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help.

Providing Feedback

Your comments and feedback are welcome, and the PSD team is monitoring this GitHub regularly.

Reporting Issues

Please share any of the following:

  • Reproducible problem(s) in a lab, testing or production
  • Feature request(s)
  • Comments, observations, notations, etc.

Check for existing issues first

  • Enter and monitor PSD issues via the PSD GitHub Issues tab. You can sort by author, contributor, label (class), and more here.
  • Before you creating new issues, search first! Be sure to check out the Advanced Search features of GitHub
  • Be sure to scan through the MOST POPULAR most popular feature requests.
  • If you find your issue already exists, contribute relevant comments and add your reaction

    ProTip: Use a reaction response rather than "+1" in a comment field

    • 👍 -> UpVote
    • 👎 -> DownVote

If you cannot find an existing issue similar to your bug or feature, create a new issue using the guidelines below.

Submitting Bug Reports and Feature Requests

  • Please only one issue or feature request per submission.
  • Do not enumerate multiple bugs or feature requests in the same issue.
  • Do not add your issue as a comment to an existing issue unless it's for the identical input.
  • Many issues look similar, but may have different causes.
  • More information is better, provide sufficient details to reproduce or narrow down the problem.

PSD Contribution Checklist

Please remember to do the following:

  • Search the issue repository before submitting new issues
  • Recreate the issue to ascertain if it is repeatable
  • Simplify your scenario and isolate the problem if possible
  • Document your findings by providing logs, log snippets and/or screen shots
  • Comment add your comments and observations to existing issues
  • Vote add your vote (via reactions) to existing issues
  • Track your submission and monitor the submission workflow

Thank You!

Your contributions and involvement will help to ensure the growth and success of PSD!