-
Notifications
You must be signed in to change notification settings - Fork 27
doc: Updated CONTRIBUTING.md file to aid testing and knowledge transfer #150
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
Open
osagiestar
wants to merge
10
commits into
master
Choose a base branch
from
UpdateCONTRIBUTING.mdFile
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
cbb726f
Updated CONTRIBUTING.md file to aid testing and knowledge transfer
osagiestar 7fdbc9a
Corrected some typo errors in the CONTRIBUTING.md file
osagiestar 9b73b63
docs: elaborate on testing process for new contributors
tdashworth 663b703
Updating CONTRIBUTING.md file
osagiestar 3961e36
Added the 'Useful Resources' section on the CONTRIBUTING.md file
osagiestar f60c378
docs: project architecture
tdashworth fa86187
Update CONTRIBUTING.md
osagiestar eb9bf7b
Update CONTRIBUTING.md
osagiestar fd76417
Update CONTRIBUTING.md
tdashworth cf72081
Merge branch 'master' into UpdateCONTRIBUTING.mdFile
tdashworth 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 |
|---|---|---|
| @@ -1,10 +1,40 @@ | ||
| # Contributing | ||
|
|
||
| Please first discuss the change you wish to make via an issue before making a change. | ||
|
|
||
| ## Testing | ||
|
|
||
| For a PR to be successfully merged, we aim for all tests to pass. Sometimes this isn't possible as the Power Platform changes, our tests aren't always kept up to date. We do require that there are tests for new/changed features and these. | ||
|
|
||
|
|
||
| In order to test the library locally, please follow these steps: | ||
|
|
||
| 1. Open the solution in Visual Studio - we've found this has the best developer experience. Install the [SpecFlow extension](https://marketplace.visualstudio.com/items?itemName=TechTalkSpecFlowTeam.SpecFlowForVisualStudio2022) to add intellisense to the `.feature` files. | ||
| 1. [Optional] Create a PowerApps environment. You need a PowerApps environment to execute the tests against so if you don't have System Administrator access to an existing one, we recommend using the free [Developer Plan](https://powerapps.microsoft.com/en-us/developerplan/). | ||
| 1. [Adjust environment personalization](https://powerusers.microsoft.com/t5/Building-Power-Apps/Model-driven-app-dates-in-UK-format/td-p/1520165). Our tests expect a UK format for dates, times, and currency so please set this for any configured users (below). | ||
| 1. Configure the test suite to use your environment. The `power-apps-bindings.yml` file holds these details. Each property value can either point to a [user environment variable](https://www.alphr.com/environment-variables-windows-10/) or hold the raw value. <span style="color: red">**We strongly recommend environment variables to avoid committing your credentials.**</span> The following properties are required: | ||
| - `url` | ||
| - `applicationUser` - an [Application User](https://learn.microsoft.com/en-us/power-platform/admin/manage-application-users#create-an-application-user) must be added with the System Administrator role to your environment. | ||
| - `users` - this can be your account, there is no need to create additional user. All username and password can be identical. | ||
| 1. Tweak config for local debugging. The `power-apps-bindings.yml` file is configured for use by the build server (that runs all tests before merge a PR) and therefore it is recommended to change the following properties without committing them. | ||
| - Change `headless` to `false` so you can observer the tests run. | ||
| - Comment `driversPath` as this environment variable won't exist locally e.g. | ||
| ```yml | ||
| #driversPath: ChromeWebDriver | ||
| ``` | ||
|
|
||
| Other things to note: | ||
|
|
||
| - Running all tests are **not** required as the CI/PR build will do these. Test and verify only the steps or features you have impacted or made changes to. | ||
| - The first time you run the test suite, a managed solution will be installed into the environment which takes a couple minutes. If the first test run times out, try again - it was likely due to this. | ||
| - At times when buiding a solution, it fails and you receive some Build.exe errors or warnings. This prevents you from cancelling the build process as it hangs. You can stop or kill the Build.exe proceess by starting the Task Master and ending the process - you can close the Visual Studio and restart it if this doesn't work. You can also run this code (taskkill /f /im chromedriver.exe) on your terminal. | ||
|
|
||
| ## Pull request process | ||
|
|
||
| 1. Ensure that there are automated tests that cover any changes | ||
| 1. Update the README.md with details of any significant changes to functionality | ||
| 1. Ensure that your commit messages increment the version using [GitVersion syntax](https://gitversion.readthedocs.io/en/latest/input/docs/more-info/version-increments/). If no message is found then the patch version will be incremented by default. | ||
| 1. You may merge the pull request once it meets all of the required checks. If you do not have permision, a reviewer will do it for you | ||
| 1. You may merge the pull request once it meets all of the required checks. If you do not have permision, a reviewer will do it for you | ||
|
|
||
| ## Useful Resources | ||
| - A presentation on the SpecFlowBinding and EasyRepro setup with demo https://triciasinclair.com/2020/11/30/using-specflow-and-easyrepro-to-improve-automated-ui-testing/ | ||
osagiestar marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.