Skip to content

Latest commit

 

History

History
60 lines (51 loc) · 2.97 KB

CONTRIBUTION.md

File metadata and controls

60 lines (51 loc) · 2.97 KB
Raw

How to contribute

Contributions to PSP-Office365 are highly encouraged and desired. Below are some guidelines that will help make the process as smooth as possible.

Getting Started

  • Make sure you have a GitHub account.
  • Submit a new issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository to your GitHub account.

Suggesting Enhancements

I want to know what you think is missing from PSP-Office365 and how it can be made better.

  • When submitting an issue for an enhancement, please be as clear as possible about why you think the enhancement is needed and what the benefit of it would be.

Making Changes

  • From your fork of the repository, create a topic branch where work on your change will take place.
  • To quickly create a topic branch based on master; git checkout -b my_contribution master. Please avoid working directly on the master branch.
  • Make commits of logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Please follow the prevailing code conventions in the repository. Differences in style make the code harder to understand for everyone.
  • Make sure your commit messages are in the proper format.
    Add more cowbell to Get-Something.ps1

    The functionaly of Get-Something would be greatly improved if there was a little
    more 'pizzazz' added to it. I propose a cowbell. Adding more cowbell has been
    shown in studies to both increase one's mojo, and cement one's status
    as a rock legend.
  • Make sure you have added all the necessary Pester tests for your changes.
  • Run all PESTER tests in the module to assure nothing else was accidentally broken.

Documentation

If you find any of the following in the documentation, please file an issue - the maintainers consider these to be bugs as serious as bugs in the code:

  • Grammatical errors
  • Dead links
  • Examples that don't function as stated
  • Explanations that you don't understand on fewer than three read-throughs
  • Language that is too wordy or not clear enough
  • Concepts that aren't explained fully
  • Questions you have that aren't answered by the docs
  • Others we haven't thought of yet

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a merge request to the main repository.
  • Once the merge request has been reviewed and accepted, it will be merged with the master branch.
  • Celebrate

Additional Resources