Skip to content
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

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

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

osagiestar
Copy link
Collaborator

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

@osagiestar osagiestar changed the title Updated CONTRIBUTING.md file to aid testing and knowledge transfer doc: Updated CONTRIBUTING.md file to aid testing and knowledge transfer Sep 23, 2022
Copy link
Contributor

@tdashworth tdashworth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Collaborator Author

Aah! I have sorted the typos. Cheers

@osagiestar
Copy link
Collaborator Author

@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
Copy link
Contributor

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
Copy link
Contributor

@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
Copy link
Collaborator Author

@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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@tdashworth tdashworth marked this pull request as draft September 26, 2022 15:34
tdashworth and others added 3 commits September 27, 2022 13:56
Co-authored-by: Tom Ashworth <tom.ashworth@capgemini.com>
Co-authored-by: Tom Ashworth <tom.ashworth@capgemini.com>
Copy link
Collaborator Author

@osagiestar osagiestar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tdashworth - Looks good to me

@osagiestar osagiestar marked this pull request as ready for review September 27, 2022 14:12
@sonarcloud
Copy link

sonarcloud bot commented Sep 27, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants