-
-
Notifications
You must be signed in to change notification settings - Fork 1
feat: add Search-Repo function and update documentation #80
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.
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Semantic Commit Messages | ||
|
|
||
| See how a minor change to your commit message style can make you a better programmer. | ||
|
|
||
| Format: `<type>(<scope>): <subject>` | ||
|
|
||
| `<scope>` is optional | ||
|
|
||
| ## Example | ||
|
|
||
| ``` | ||
| feat: add hat wobble | ||
| ^--^ ^------------^ | ||
| | | | ||
| | +-> Summary in present tense. | ||
| | | ||
| +-------> Type: chore, docs, feat, fix, refactor, style, or test. | ||
| ``` | ||
|
|
||
| More Examples: | ||
|
|
||
| - `feat`: (new feature for the user, not a new feature for build script) | ||
| - `fix`: (bug fix for the user, not a fix to a build script) | ||
| - `docs`: (changes to the documentation) | ||
| - `style`: (formatting, missing semi colons, etc; no production code change) | ||
| - `refactor`: (refactoring production code, eg. renaming a variable) | ||
| - `test`: (adding missing tests, refactoring tests; no production code change) | ||
| - `chore`: (updating grunt tasks etc; no production code change) | ||
|
|
||
| References: | ||
|
|
||
| - https://www.conventionalcommits.org/ | ||
| - https://seesparkbox.com/foundry/semantic_commit_messages | ||
| - http://karma-runner.github.io/1.0/dev/git-commit-msg.html |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Copilot Instructions | ||
|
|
||
| ## Powershell Modules Code Instructions | ||
|
|
||
| ### PowerShell Functions Instructions | ||
|
|
||
| Every powershell function will contain the `CmdletBinding` attribute and the `parm`iven if there are no parameters. | ||
| If the function is on the public folder of the module, we will add the Èxport-ModuleFunction` statement in the same line as the closing `}` of the function | ||
|
|
||
| Sample of function will be: | ||
|
|
||
| ```powershell | ||
|
|
||
| function Get-UserName{ | ||
| [CmdletBinding()] | ||
| param() | ||
|
|
||
| #Logic of the function | ||
| } Export-ModuleFunction -FunctionName 'Get-UserName' | ||
| ``` | ||
|
|
||
| ### PowerShell Test Instructions | ||
|
|
||
| Every public function on the Test module will have the following format | ||
|
|
||
| - Name will start with `Test_` will follow the name of the function that we are testing with no '-'. It will follow the intention of the test splited with a '_' | ||
| - Every time we create a new function with no body we will add the `Assert-NotImplemented` statement at the end | ||
| - We will add the 3 sections as with comments `Arrange`, `Act` and `Assert` to make the test more readable. | ||
| - Sample of a test function to test `Get-UserName` function will be `Test_GetUserName_UserNotFound` | ||
|
|
||
| Full sample will be as follows | ||
|
|
||
| ```powershell | ||
| function Test_GetUserName_UserNotFound{ | ||
|
|
||
| # Arrange | ||
|
|
||
| # Act | ||
|
|
||
| # Assert | ||
|
|
||
| Assert-NotImplemented | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Pull Request Code Instructions | ||
|
|
||
| ## PR TITLE | ||
|
|
||
| Follow this guidelines to construct the title of your pull request. | ||
|
|
||
| Format: `<type>(<scope>): <subject>` | ||
|
|
||
| `<scope>` is optional | ||
|
|
||
| ## Example | ||
|
|
||
| ``` | ||
| feat: add hat wobble | ||
| ^--^ ^------------^ | ||
| | | | ||
| | +-> Summary in present tense. | ||
| | | ||
| +-------> Type: chore, docs, feat, fix, refactor, style, or test. | ||
| ``` | ||
|
|
||
| More Examples: | ||
|
|
||
| - `feat`: (new feature for the user, not a new feature for build script) | ||
| - `fix`: (bug fix for the user, not a fix to a build script) | ||
| - `docs`: (changes to the documentation) | ||
| - `style`: (formatting, missing semi colons, etc; no production code change) | ||
| - `refactor`: (refactoring production code, eg. renaming a variable) | ||
| - `test`: (adding missing tests, refactoring tests; no production code change) | ||
| - `chore`: (updating grunt tasks etc; no production code change) | ||
|
|
||
| References: | ||
|
|
||
| - https://www.conventionalcommits.org/ | ||
| - https://seesparkbox.com/foundry/semantic_commit_messages | ||
| - http://karma-runner.github.io/1.0/dev/git-commit-msg.html | ||
|
|
||
| ## Pull Reques description | ||
|
|
||
| - Add a summery of the intention of the PR. Use the title and the messages of the commits to create a summary. | ||
| - Add a list with all the commit messages in the PR. | ||
|
|
||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check notice
Code scanning / PSScriptAnalyzer
The cmdlet 'Search-Repo' does not have a help comment. Note