Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Make license documentation consistent #2628

Conversation

calvinballing
Copy link
Collaborator

@calvinballing calvinballing commented Oct 8, 2023

Make license documentation consistent

Dictionaries (update license info): de_DE, es_ES, pl_PL

Description

In each of these dictionaries, there are the following:

  1. a LICENSE file
  2. a license listed in package.json
  3. a license referenced in the README.

In these three dictionaries, (1) and (2) match, but (3) did not, and instead said MIT. This PR does not change the license the dictionaries are released under, but does fix the documentation in the READMEs so that (3) matches (1) and (2).

References

n/a

Fix links

Additionally, this changes some relative links to hard-coded URLs, so that they will work in their NPM packages:

Dictionaries (update links): cs_CZ, de_DE, en_AU, en_CA, en_GB, en_GB-MIT, en_US, es_ES, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, sk_SK, sl_SI

Checklist

  • By submitting this issue, you agree to follow our
    Code of Conduct
  • Verify that the title starts with the correct prefix:
    • fix: - for minor changes like adding words or fixing spelling issues.
    • feat: - for a significant change like adding a whole new set of words to a dictionary.
    • feat!: - for breaking changes, like file format or licensing changes.
    • chore: - for changes that do not impact the content of dictionaries.

GPL-3.0-or-later

> Some packages may have other licenses included.
> See [src/hunspell/license](./src/hunspell/license) and [src/German_de_DE.txt](./src/German_de_DE.txt)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Links in the dictionary READMEs need to be a full URL, since they get published to NPM as is and will just link to a 404.

Like: https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/de_DE/src/German_de_DE.txt

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had copied this pattern from another README, so I've also gone through and updated the other READMEs that were the same way

@Jason3S
Copy link
Collaborator

Jason3S commented Oct 9, 2023

Thank you.

@calvinballing calvinballing force-pushed the make-license-documentation-consistent branch from e22ec86 to 3798b26 Compare October 9, 2023 17:42
@calvinballing calvinballing force-pushed the make-license-documentation-consistent branch from 3798b26 to 5740792 Compare October 9, 2023 18:22
@Jason3S
Copy link
Collaborator

Jason3S commented Oct 10, 2023

@calvinballing,

Thank you.

This is more of a doc change than a feature. I'll mark it as a fix so they get published, but it is not a significant enough change to warrant a minor version bump.

@Jason3S Jason3S changed the title feat: Make license documentation consistent fix: Make license documentation consistent Oct 10, 2023
@Jason3S Jason3S merged commit 0dfc5e9 into streetsidesoftware:main Oct 10, 2023
8 checks passed
This was referenced Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants