BatmanAoD commented 4 years ago

Testing instructions, etc

Description

I took the paragraph on testing in the existing CONTRIBUTING.md and separated it into its own section, then added some details.

I also checked in the go.mod changes created by running go test, as well as the generated go.sum file, since xgen is an executable rather than a module.

Finally, I added data/ to .gitignore to facilitate changing the "active" test set without accidentally duplicating it under version control.

Related Issue

Resolves #9.

Motivation and Context

Specific instructions for running tests help potential new contributors.

How Has This Been Tested

I was able to run the parser tests on the base64.xsd input using the instructions I added.

Types of changes

[x] Docs change / refactoring / dependency upgrade
[ ] 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

[ ] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my changes.
[x] All new and existing tests passed.

BatmanAoD commented 4 years ago

Because the GH Action uses a timeout of 60 minutes for the full test suite, I did not attempt to run it on my personal machine. I did try running just TestParseGo with -v but canceled it after a minute or so.

xuri commented 4 years ago

LGTM, thanks for your contribution.

xuri / xgen

Testing instructions #11