search

ocaml-semver / ocaml-api-watch

Libraries and tools to keep watch on you OCaml lib's API changes
ISC License
21 stars 15 forks source link

Add test cases for diffing changes to modules #10

Closed shonfeder closed 8 months ago

shonfeder commented 8 months ago

Having a few simple test cases for different API changes would make for a great way to monitor progress on api-diff initial implementation.

Add tests that will check the behavior of api-diff when

Those tests should be added to tests/api-diff/run.t. This will require either modifying the existing ref.mli file created in that test, or creating a new mod_ref.mli file, because ref.mli doesn't include a module already. For each test case we should generate a new .mli file with a change from the list above, compile it to a .cmi with ocamlc and then run api-diff ref.cmi <test-file.cmi>.

You can read about the testing methodology used for the tests at https://github.com/NathanReb/ocaml-api-watch/blob/main/CONTRIBUTING.md#writing-tests

nebadesmondc commented 8 months ago

Can you please assign me this issue @NathanReb

Payne680 commented 8 months ago

@NathanReb please can you assign me this task cause am available to work on it asap

dinakajoy commented 8 months ago

@Dezzy12 are you still interested in this task?

nebadesmondc commented 8 months ago

Yes I am

harshey1103 commented 8 months ago

@shonfeder please assign me this issue.

harshey1103 commented 8 months ago

Just one small question. Should I open a new PR or continue with existing PR on this issue?

shonfeder commented 8 months ago

Whichever you prefer!