Skip to content

Add a paragraph on files.wxs updating #7695

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.

Sign up for GitHub

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
TravisEz13 merged 1 commit into from
Sep 4, 2018
Merged

Add a paragraph on files.wxs updating #7695

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Additional references:
and is recommended by the Git SCM developers.
It is also used in the [Git commit messages](#common-engineering-practices).
* If the change is related to a specific resource, please prefix the description with the resource name:
* Instead of "New parameter 'ConnectionCredential' in New-SqlConnection",
* Instead of "New parameter 'ConnectionCredential' in New-SqlConnection",
write "New-SqlConnection: add parameter 'ConnectionCredential'".
* If your change warrants an update to user-facing documentation,
a Maintainer will add the `Documentation Needed` label to your PR and add an issue to the [PowerShell-Docs repository][PowerShell-Docs],
Expand All @@ -151,15 +151,17 @@ Additional references:
(See [Contributing to documentation related to PowerShell](#contributing-to-documentation-related-to-powershell) for more info.)
* If your change adds a new source file, ensure the appropriate copyright and license headers is on top.
It is standard practice to have both a copyright and license notice for each source file.
* For `.h`, `.cpp`, and `.cs` files use:
* For `.h`, `.cpp`, and `.cs` files use:

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

* For `.ps1` and `.psm1` files use:
* For `.ps1` and `.psm1` files use:

```powershell
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
```
Copy link
Member

@TravisEz13 TravisEz13 Sep 4, 2018

Choose a reason for hiding this comment

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

Can you add that there should be an empty line following the copyright header?

Copy link
Collaborator Author

@iSazonov iSazonov Sep 5, 2018

Choose a reason for hiding this comment

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

Done in #7706.


* If your change adds a new module manifest (.psd1 file), ensure that:

Expand All @@ -186,6 +188,18 @@ Additional references:
* Our CI contains automated spellchecking. If there is any false-positive,
[run the spellchecker command line tool in interactive mode](#spellchecking-documentation)
to add words to the `.spelling` file.
* Our packaging test may not pass and ask you to update `files.wxs` file if you add/remove/update nuget package references or add/remove assert files.

You could update the file manually in accordance with messages in the test log file. Or you can use automatically generated file. To get the file you should build the msi package locally:

```powershell
Import-Module .\build.psm1
Start-PSBuild -Clean -CrossGen -PSModuleRestore -Runtime win7-x64 -Configuration Release -ReleaseTag <release tag>
Import-Module .\tools\packaging
Start-PSPackage -Type msi -ReleaseTag <release tag> -WindowsRuntime 'win7-x64' -SkipReleaseChecks
```

Last command will report where new file is located.

#### Pull Request - Workflow

Expand Down