search

spdx / ntia-conformance-checker

Check SPDX SBOM for NTIA minimum elements
Apache License 2.0
47 stars 18 forks source link

Spelling: Minimum vs mininum #174

Closed thireo closed 3 months ago

thireo commented 4 months ago

There's a small spelling mistake in the function ntia_mininum_elements_compliant and therefore also in the README.

Suggestion: ntia_minimum_elements_compliant

jspeed-meyers commented 4 months ago

@thireo, thank you for the bug report. PR's welcome

But this will be a breaking change, won't it? @goneall, should I bump the version to 2.x? What do you advise? This silly typo is definitely my fault. Oops.

thireo commented 4 months ago

Let me know if I need to change anything in my PR or commit. I'm not entirely sure of the correct way of doing this.

jspeed-meyers commented 4 months ago

Thank you, @thireo. One minor request: Can you please use the black formatter? See the PR thread for further info.

jspeed-meyers commented 4 months ago

@goneall -- friendly ping. What do you think is the best approach to handling this breaking change?

goneall commented 4 months ago

@jspeed-meyers - yes, probably a breaking change - even though pretty minor. Since it is breaking, we should probably go to the next major version number. Is there any other planned changes that may be breaking we should include in a major release?

jspeed-meyers commented 4 months ago

@goneall: I don't currently have any plans for other breaking changes. Given that, should we delay cutting a new release for a couple of months just to see if there any other breaking changes? Or should I merge the associated PR here and cut a release ASAP?

I'll make sure the release notes clearly explain this change, BTW.

goneall commented 4 months ago

should I merge the associated PR here and cut a release ASAP?

Unless @thireo would like these changes merged in quickly, I think we should wait 3 to 4 weeks and see if there are any other breaking changes.

I added a 2.0.0 milestone to the project, so we can tag any PR's and Issues with the release milestone.

@thireo - OK to wait a month or two for this fix?

jspeed-meyers commented 4 months ago

Thank you for the wise advice, @goneall. And thank you for creating the 2.0.0 milestone. That sounds like a plan to me.

thireo commented 4 months ago

I'm okay waiting a month for this to be merged. I'll just use my own patch meanwhile :)

jspeed-meyers commented 4 months ago

Okay, I merged this fix. But I will not cut a version until early April.