Contributing

[chadhietala]

Hello! I started using the api package to build out some documentation tools after running into issues with other tools in this space. Overall its been great. I do have a list of issues and potential areas for enhancement and was wondering if you're accepting contributions to the project.

Below are some of the issues that I recently found

• Getter/Setter Parsing Issues #19
• undefined and object literal kinds missing in array values #20
• Enum References Not Captured #21

[atanasster]

Thanks @chadhietala for reporting the issues you encountered and would love to have contributions. It just so happened that the project is not very much promoted and so far have handled most issues myself, but definitely have nothing against contributions :)

Let me know if you need any help, or if you prefer me to handle any of your issues.

[chadhietala]

@atanasster I was looking at #19 and I believe the issue stems from this guard but I wasn't really sure how to evolve the code. If you have the time seeing the fix for that will give me a better idea on how to go about fixing some of the other issues.

[atanasster]

@chadhietala you were absolutely on the right path for the fix, its just a bit more clunky.

I have fixed it now with #23 and it was published as @structured-types/[email protected]

Since the tests already included a test for getters/setters, I did not create a new test and just modified the existing one to expect the names of the getters/setters. For other issues it might be expected to create new tests and add them to the site examples.