Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 2.76 KB

Contribution Guidelines

Thank you for taking the time to contribute to this project👏

The followings are the types of contributions we expect and the guidelines to follow.

Reporting Bugs

  • Make sure that you are using the latest version
  • Go to issues page and confirm that there is not already an existing bug report.
  • File an issue and follow the Bug Report issue form.

Suggesting Enhancements

If you are thinking about requesting new features or minor improvements to existing functionality, please follow the steps below:

  • Read the documentation carefully and confirm that the functionality is not covered already.
  • Go to issues page and confirm that there is not already an existing enhancement request.
  • File an issue and follow the Feature Request issue form.

Making Pull Requests

When you make a code contribution, you must agree that the content you submit is provided under the project license. To make a PR, please follow the steps below:

  • File an issue by following the above guidelines before making a PR
  • In the issue, suggest that you are willing to make a PR
  • Fork this repository
  • Create a branch in your forked repository with a meaningful name (e.g. add-file-manager-entry)
  • Make the changes in the branch and push the commits
  • Create a PR in the original repository

Build and Test

Before building the project, you need .NET SDK installed. Follow the steps in the Microsoft documentation and install the latest SDK. After getting the access to the donet command, you can build the project by calling the build script:

& .\Build.ps1

After the build, basic functionalities that are not dependent to the interactive part can be tested using Pester:

& .\tests\RunPesterTests.ps1

For interactive testing on the console, we recommend that you install RestartableSession module. Once installed, you can set up a testing console by running this script:

& .\tests\RestartableSession.ps1

This script builds the project and import the built module. When you make a code modification, you can just call restart command to do the same process (build and import). The Pester test can be run by pester command.

Coding

When you make a code modification, please follow the style of the existing code. For code formatting, we recommend that you use Visual Studio Code since the formatting settings are included in .vscode folder.