doc: Updated CONTRIBUTING.md file to aid testing and knowledge transfer

[osagiestar]

Purpose

This is to support team members especially new joiners who will want to use the project for testing and for running the application

Approach

Some challenges were encountered while testing on local machine, for example, a user will often experience bugs which are datetime related. Following these steps will help avoid common issues related to the tool or setups etc

TODOs

• Automated test coverage for new code
• Documentation updated (if required)
• Build and tests successful

[tdashworth]

Hey @osagiestar! This is an excellent start 😄

Could you check the spelling as I noticed a few mistakes?

Also, please review the two related issues (#133 and #132) for some additional content to add.

[osagiestar]

Aah! I have sorted the typos. Cheers

[osagiestar]

@tdashworth: My idea about the CONTRIBUTING.md is to report some of the findings we made during testing that will be helpful to EasyRepro for fixing identified bugs for future releases. Therefore, we keep these findings and details of the fixes on the file.
While the README.md file which already has info on installation, configuration, the tools/kits (SpecFlow, Selenium, etc that you suggested on docs #132 and #133) can just updated it with further info. Otherwise, there might be repetitions.

[tdashworth]

Manual validation requested
Please perform any checks required on https://sfb-pr-8095.crm11.dynamics.com/ then approve https://dev.azure.com/capgeminiuk/GitHub%20Support/_build/results?buildId=8095.

[tdashworth]

@tdashworth: My idea about the CONTRIBUTING.md is to report some of the findings we made during testing that will be helpful to EasyRepro for fixing identified bugs for future releases. Therefore, we keep these findings and details of the fixes on the file.
While the README.md file which already has info on installation, configuration, the tools/kits (SpecFlow, Selenium, etc that you suggested on docs #132 and #133) can just updated it with further info. Otherwise, there might be repetitions.

I think reporting those will be very helpful in the future!

To me, there is a difference between the README and CONTRIBUTING files. The README file explains the purpose of the project, how to start using it, and it's features - it's for the consumer. The CONTRIBUTING file is for someone making changes in the repo - what's the process, what is the architect, how to test.

I think we can add some more to this to help new contributors. I'll try to find some time on Monday.

[osagiestar]

@tdashworth: My idea about the CONTRIBUTING.md is to report some of the findings we made during testing that will be helpful to EasyRepro for fixing identified bugs for future releases. Therefore, we keep these findings and details of the fixes on the file.
While the README.md file which already has info on installation, configuration, the tools/kits (SpecFlow, Selenium, etc that you suggested on docs #132 and #133) can just updated it with further info. Otherwise, there might be repetitions.

I think reporting those will be very helpful in the future!

To me, there is a difference between the README and CONTRIBUTING files. The README file explains the purpose of the project, how to start using it, and it's features - it's for the consumer. The CONTRIBUTING file is for someone making changes in the repo - what's the process, what is the architect, how to test.

I think we can add some more to this to help new contributors. I'll try to find some time on Monday.

@tdashworth I completely agree with you on updating the files.

[osagiestar]

@tdashworth - Looks good to me

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information