Skip to content

Commit

Permalink
Update readme and contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
p-goulart committed May 2, 2024
1 parent 188e712 commit 8ed8b5f
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,7 @@ Note that the `Build` check can take a while to run, so please be patient. This
from source, compile LT from source, build the tagger dictionary... and then recompile LT with the new tagger logic,
which is used by the spelling dictionary compilation scripts... And then, on top of that, run the LT tests, which can
be quite time-consuming. With no caching, this can take up to ca. 17 minutes.

We have a separate workflow specifically designed simply to check if all status are passing. Because of how long it
takes to run the `Build` check, this workflow may sometimes fail because of a timeout. If that happens, you can simply
re-trigger it once all statuses are passing and your PR will be good to go.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,19 @@ Soon, this will be no longer be the case, and they will be released automaticall
### Versioning

These dictionaries use [semantic versioning](https://semver.org), as they are essentially libraries that can be
declared as dependencies by LT. We only use major and minor, without a patch number, e.g. `0.9`.
declared as dependencies by LT.

As of May 2024 (with release `v1.0.0`), we are using the following versioning scheme:
- update the **major** (i.e. the first number) for *breaking* changes;
- these are changes that depend on **code** changes in LT, e.g.:
- changes to the way dictionaries built or loaded;
- changes to the logic of Portuguese word tokenisation, POS tagging, or spellchecking;
- changes that would necessitate **extensive** rewriting of the Portuguese XML rules.
- update the **minor** (i.e. the second number) for *new features*;
- primarily, this will mean new words added to either the spelling or the tagging dictionary;
- update the **patch** (i.e. the third number) for *bug fixes*;
- this includes typos, incorrect POS tags, or any other minor errors in the dictionaries that do not constitute
'new content'.

Note that, in order for LT to actually use the newly released version, you'll need to update the version of the
`portuguese-pos-dict` dependency in **LT**'s main `pom.xml` file.
Expand Down

0 comments on commit 8ed8b5f

Please sign in to comment.