Skip to content

Fix a few sentences in contributing docs #5029

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
sdwheeler merged 1 commit into from
Oct 30, 2019
Merged

Fix a few sentences in contributing docs #5029

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
10 changes: 5 additions & 5 deletions contributing/6-UPDATING-REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ errors that must be fixed before we can accept your contribution.
## Formatting About_ files

`About_*` files are now processed by [Pandoc][], instead of PlatyPS. `About_*` files are formatted
for the best compatibility across with all versions of PowerShell and with the publishing tools. For
for the best compatibility across all versions of PowerShell and with the publishing tools. For
details, see [issue #1806][issue1806]. Please do not alter the formatting of `about_*` files without
checking in with a repo maintainer.
checking with a repo maintainer.

Basic formatting guidelines:

- Limit lines to 80 characters
- Code blocks and table are limited to 76 characters - Pandoc indents these by 4 spaces during
- Code blocks and tables are limited to 76 characters - Pandoc indents these by 4 spaces during
conversion
- Tables need fit within 76 characters
- Tables need to fit within 76 characters
- Manually wrap contents of cells across multiple lines
- Use opening and closing `|` characters on each line
- See a working example in [about_Comparison_Operators][about-example]
Expand Down Expand Up @@ -84,4 +84,4 @@ See the [Pull Requests](7-PULL-REQUESTS.md) article.
[platyPS.schema.md]: https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md
[issue1806]: https://github.com/PowerShell/PowerShell-Docs/issues/1806
[about-example]: ../reference/5.1/Microsoft.PowerShell.Core/About/about_Comparison_Operators.md
[Pandoc]: https://pandoc.org
[Pandoc]: https://pandoc.org