leihou6116 commented on PR #38459: URL: https://github.com/apache/arrow/pull/38459#issuecomment-1779531588
> Thank you @leihou6116 for the pull request! This is an excellent addition to the MATLAB interface documentation and should definitely help new contributors get familiar with our approach to testing! It's really great to see this being added! > > I added a number of comments to the PR - but many of them are actually just minor suggestions for tweaking the wording of some sections. > > Overall, I think this nicely addresses most of the core themes that are relevant for getting started with testing the MATLAB interface. > > The only thing I think would be helpful to think about adding is a small section on "Testing Best Practices". This could be a simple bulleted list of things like: > > 1. Focus on testing _one_ software "behavior" in each test case. > 2. Test with both "expected" _and_ "unexpected" inputs. > 3. Add a comment at the beginning of each test case which describes what the test case is verifying. > 4. Treat test code like any other code (i.e. use clear variable names, write helper functions, make use of abstraction, etc.) > 5. Follow existing patterns when adding new test cases to an existing test class. > 6. Use descriptive names for your test cases. > . > . > . Thank you Kevin for excellent review feedback. I'll address all and add the section of "Testing Best Practices". -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
