Open-Cap-Table-Coalition / Open-Cap-Format-OCF

Open Cap Format (OCF) - The Open Source Company Capitalization Data Standard. OCF can be used to structure and track the complex data structures necessary to build and maintain accurate capitalization (cap) tables.
https://opencaptablecoalition.com
Other
143 stars 30 forks source link

fix: Updated quantity source type to live under the enums package instead of the types package #456

Closed lavens closed 7 months ago

lavens commented 10 months ago

What type of PR is this?

/kind bug

What this PR does / why we need it:

This PR moves QuantitySourceType.schema.json to the enums package to match the path defined in the WarrantIssuance.schema.json. This change addresses an issue encountered when using a JSON Schema code generation tool.

Separately, the QuantitySourceType is keyed as "quantity_source" where enums are typically postfixed with type. Looking for guidance on if quantity_source should be updated to quantity_source_type for consistency, and what the process is for handling a breaking change.

JSv4 commented 8 months ago

@lavens, sorry we missed this last year. I like the suggestion from the Mantle team to have a response bot that can give people a clearer expectation of response time and process. We'll take a look at this. In order to merge it needs a format review in GitHub and typically, if it's a substantive change, we'd discuss and approve it at the TWG level. For a bug fix, a code review and approval would be sufficient.

lavens commented 8 months ago

@JSv4 thanks for the review! I've gone ahead and made the necessary updates.