From a0fc878ebe13f39145ee81133d6e6258d82c936f Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Mon, 22 Oct 2018 13:00:43 +0200 Subject: [PATCH] Fixed markdown syntax and added spellcheck --- .gitattributes | 34 ++--- .github/ISSUE_TEMPLATE.md | 32 ----- .github/PULL_REQUEST_TEMPLATE.md | 10 +- .gitignore | 2 + .spelling | 216 ++++--------------------------- .vscode/extensions.json | 3 +- .vscode/settings.json | 8 ++ 7 files changed, 65 insertions(+), 240 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.gitattributes b/.gitattributes index 7488f718..daee888f 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,21 +1,25 @@ +# Set merge behavior for the changelog +CHANGELOG.md merge=union + # Set default behaviour, in case users don't have core.autocrlf set. * text=auto -# Explicitly declare text files we want to always be normalized and converted -# to native line endings on checkout. -*.md text -*.gitattributes text - -# Declare files that will always have CRLF line endings on checkout. -*.ps1 text eol=crlf -*.psm1 text eol=crlf -*.psd1 text eol=crlf -*.psc1 text eol=crlf -*.ps1xml text eol=crlf -*.clixml text eol=crlf -*.xml text eol=crlf -*.txt text eol=crlf +# Explicitly declare text files we want to always be normalized. +*.md text eol=crlf +*.gitattributes text eol=crlf +*.gitignore text eol=crlf +*.ps1 text eol=crlf +*.psm1 text eol=crlf +*.psd1 text eol=crlf +*.psc1 text eol=crlf +*.ps1xml text eol=crlf +*.clixml text eol=crlf +*.cs text eol=crlf +*.xml text eol=crlf +*.yml text eol=crlf +*.txt text eol=crlf +*.json text eol=crlf # Denote all files that are truly binary and should not be mergeable. *.dll binary -*.exe binary \ No newline at end of file +*.exe binary diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index d3340f73..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,32 +0,0 @@ - - -### Expected Behavior - - - -### Current Behavior - - - -### Possible Solution - - - -### Steps to Reproduce (for bugs) - -1. -2. -3. -4. - -### Context - - - -### Your Environment - - -> ```powershell -> Get-Module JiraPS -ListAvailable | select version -> $PSVersionTable -> ``` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 55303de3..af558991 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,22 +1,30 @@ + + ### Description + ### Motivation and Context + ### Types of changes + + - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) -### Checklist: +### Checklist + + - [ ] My code follows the code style of this project. - [ ] I have added Pester Tests that describe what my changes should do. - [ ] I have updated the documentation accordingly. diff --git a/.gitignore b/.gitignore index 1a0de62b..379130b3 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,8 @@ config.xml # except for git files !.gitattributes !.gitignore +!.editorconfig +!.spelling !.github/ !.vscode/ !.travis.yml diff --git a/.spelling b/.spelling index d85578c7..1531e62b 100644 --- a/.spelling +++ b/.spelling @@ -1,205 +1,39 @@ -AppVeyor +// AtlassianPS Atlassian Atlassian's -atlassianps.org -atlassianps.slack.com -behavior -behaviors -booleans -CAPTCHA -cmd -cmdlet -cmdlets -color -colors -config -config.xml -datacenter -env -exe -github -hashtable -hashtables -hotfix -img -IssueLink Jira -JIRA -jira-screen-createissue -JIRA's -JiraPS -jql -json -MSI -multiselect -OAuth -PackageManagement -param -png -PoshCode -powershell -PowerShell -powershell.exe -PowerShellGet -projectCategory -ps1 -PSGallery -PSJira -PSModulePath -ReadTheDocs -vscode -WindowsPowerShell -worklog - -# Commands -Add-JiraGroupMember -Add-JiraIssueComment -Add-JiraIssueLink -Add-JiraIssueWatcher -Add-JiraIssueWorklog -ConvertFrom-Json2 -ConvertTo-JiraComment -ConvertTo-JiraComponent -ConvertTo-JiraCreateMetaField -ConvertTo-JiraEditMetaField -ConvertTo-JiraField -ConvertTo-JiraFilter -ConvertTo-JiraGroup -ConvertTo-JiraIssue -ConvertTo-JiraIssueLink -ConvertTo-JiraIssueLinkType -ConvertTo-JiraIssueType -ConvertTo-JiraLink -ConvertTo-JiraPriority -ConvertTo-JiraProject -ConvertTo-JiraSession -ConvertTo-JiraStatus -ConvertTo-JiraTransition -ConvertTo-JiraUser -ConvertTo-JiraWorklogItem -Format-Jira -Get-JiraComponent -Get-JiraConfigServer -Get-JiraField -Get-JiraFilter -Get-JiraGroup -Get-JiraGroupMember -Get-JiraIssue -Get-JiraIssueComment -Get-JiraIssueCreateMetadata -Get-JiraIssueEditMetadata -Get-JiraIssueLink -Get-JiraIssueLinkType -Get-JiraIssueType -Get-JiraIssueWatcher -Get-JiraPriority -Get-JiraProject -Get-JiraRemoteLink -Get-JiraSession -Get-JiraUser -Invoke-JiraIssueTransition -Invoke-JiraMethod -New-JiraGroup -New-JiraIssue -New-JiraSession -New-JiraUser -Remove-JiraGroup -Remove-JiraGroupMember -Remove-JiraIssueLink -Remove-JiraIssueWatcher -Remove-JiraRemoteLink -Remove-JiraSession -Remove-JiraUser -Resolve-JiraError -Set-JiraConfigServer -Set-JiraIssue -Set-JiraIssueLabel -Set-JiraUser -# Data Types -Int -JiraPS.Comment -JiraPS.Component -JiraPS.CreateMetaField -JiraPS.Field -JiraPS.Filter -JiraPS.Group -JiraPS.Issue -JiraPS.IssueLink -JiraPS.IssueLinkType -JiraPS.IssueType -JiraPS.IssueType -JiraPS.Link -JiraPS.Priority -JiraPS.Project -JiraPS.Session -JiraPS.Transition -JiraPS.User -JiraPS.Watchers -PSCredential -PSCustomObject -System.Management.Automation.PSObject -System.Object -System.String +// Module specific -# Parameters -AllowedValues -ComponentId -ConfigFile -ContentType -DateStarted -DisplayName -EmailAddress -FixVersion -GroupName -IncludeDebug -IncludeInactive -InputObject -IssueType -LinkType -MaxJsonLength -MaxResults -PageSize -PassThru -SecureString -StartIndex -TimeSpent -VisibleRole -WhatIf -WriteError - -# Methods -ToString - -# ParameterSets -ByFilter -ByFilterID -ByGroupName -ByHashtable -ById -ByInputObject -ByIssueKey -ByJQL -ByNamedParameters -ByProject -ByUserName -ClearLabels -ModifyLabels -ReplaceLabels -ReturnError -WebResponse +// Powershell +pwsh +cmdlet +cmdlets +recurse +hashtable +posh -# User Names -alexsuslin -axxelG +// Person/Username +lipkau +bunke brianbunke +thomykay +juneb +alexsuslin +axxel +beaudryj +clijsters colhal dejulia489 ebekker jkknorr kittholland -LiamLeane -lipkau +liam +leane lukhase padgers -ThePSAdmin +JohnAdders + +// misc +markdownlint +veyor diff --git a/.vscode/extensions.json b/.vscode/extensions.json index f4b2d754..c54ae4a6 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -3,6 +3,7 @@ // for the documentation about the extensions.json format "recommendations": [ "ms-vscode.PowerShell", - "DavidAnson.vscode-markdownlint" + "DavidAnson.vscode-markdownlint", + "streetsidesoftware.code-spell-checker" ] } diff --git a/.vscode/settings.json b/.vscode/settings.json index 3558e98e..5c174b11 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -28,6 +28,14 @@ "MD025": false, "MD028": false }, + "cSpell.dictionaryDefinitions": [{ + "name": "customDictionary", + "path": "./.spelling" + }], + "cSpell.dictionaries": [ + "customDictionary" + ], + "cSpell.language": "en" // Recomendations for "USER SETTINGS": // "editor.formatOnType": true,