Skip to content

Commit 23498e6

Browse files
committed
all: update docs
See golang/go#53961
1 parent 43cb2ac commit 23498e6

File tree

7 files changed

+23
-47
lines changed

7 files changed

+23
-47
lines changed

AUTHORS.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

CONTRIBUTING.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ path including version (or "all" for everything or misc chores), followed
1313
by a colon. For example:
1414

1515
```
16-
v2/lazy: error when doing something
16+
v2/loader: error when doing something
1717
v2/all: help getting started
1818
```
1919

@@ -31,7 +31,7 @@ For example:
3131

3232
```
3333
all: update README
34-
lazy: fix something
34+
loader: fix something
3535
legacy/foo: fix something else
3636
```
3737

@@ -44,19 +44,13 @@ All code contributions **must** be made available under the exact same
4444
terms as the [LICENSE.txt](/LICENSE.txt) file (and cannot be accepted
4545
otherwise).
4646

47-
Contributors will have their name and email added to the CONTRIBUTORS file
48-
at the start of each minor version release.
49-
5047
If you are contributing in the course of your employment, and your employer
5148
is the copyright holder of your contribution (this is usually the case when
52-
you are contributing code at work), then please also add your employer's
53-
legal name, the country where that company is registered, and the year(s)
54-
of the contribution(s) to the AUTHORS file (please preserve alphabetical
55-
order).
49+
you are contributing code at work), then please contribute using an email
50+
address or account that credits your employer.
5651

5752
### Style guide
5853

5954
* Unlike most Go projects, we exclusively use spaces for indentation.
60-
* Use British English (en-GB) for code comments and documentation
55+
* Use British English (en-GB) for code comments and documentation.
6156
* Use US English (en-US) for identifiers and file names.
62-
* Use any English language for commit messages, pull requests, etc.

CONTRIBUTORS.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ github.com/tawesoft/golib
22

33
Copyright © 2019 - 2022 Ben Golightly <[email protected]>
44
Copyright © 2019 - 2022 Tawesoft Ltd <[email protected]>
5-
Copyright © AUTHORS and CONTRIBUTORS
5+
Copyright © CONTRIBUTORS (api.github.com/repos/tawesoft/golib/contributors)
66
Portions copyright © 1991 - 2022 Unicode, Inc. (see also UNICODE.txt)
77

88
Permission is hereby granted, free of charge, to any person obtaining a copy

MIGRATIONS.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,13 @@ described in the following table.
2323
| Unstable | Large breaking changes to this package are likely, even between minor versions, and may not have migration instructions. |
2424

2525
Security fixes may not always be backwards compatible, even between minor
26-
versions. Applicable security fixes will always be backported to frozen
27-
packages, to the previous two major versions of normal packages, and the
28-
previous one major version of candidate packages.
26+
versions.
2927

3028
Downstream module authors should avoid using a candidate package
3129
in a stable release of their module, particularly in their public API.
3230
Candidate packages are appropriate for "release candidate" pre-release
3331
versions of modules, development versions of modules, and `main()` programs.
34-
Alternatively, please vendor the package.
32+
Alternatively, please vendor the package as a temporary measure.
3533

3634

3735
## Updating `github.com/tawesoft/golib`
@@ -45,7 +43,7 @@ Placeholder
4543
## Migrating from `tawesoft.co.uk/go`
4644

4745
There are no breaking changes, but you should update your imports as indicated
48-
for each package.
46+
below for each package.
4947

5048

5149
### Package **tawesoft.co.uk/go/dialog:**
@@ -78,16 +76,7 @@ Although the new package is API-compatible with the old one, check out the
7876
```
7977

8078
This `golib/v2/legacy/humanize` package is frozen and will not appear
81-
in v3. It will always be available at the v2 import path. Note that this
82-
is different to the new (non-legacy) humanize package, which is not directly
83-
compatible with existing code.
84-
85-
### (Optional) migrate **humanize****goblib/v2/humanize:**
86-
87-
Package `goblib/v2/humanize` provides similar features to the old
88-
`tawesoft.co.uk/go/humanize` package, but migrating will require changes to
89-
existing code. Note that this package is different to the legacy humanize
90-
package, which is compatible with existing code.
79+
in v3. It will always be available at the v2 import path.
9180

9281

9382
### Package **tawesoft.co.uk/go/lxstrconv:**
@@ -102,13 +91,6 @@ package, which is compatible with existing code.
10291
This `golib/v2/legacy/localize` package is frozen and will not appear
10392
in v3. It will always be available at the v2 import path.
10493

105-
### (Optional) migrate **lxstrconv****goblib/v2/humanize:**
106-
107-
Package `goblib/v2/humanize` provides similar features to the old
108-
`tawesoft.co.uk/go/lxstrconv` package, but migrating will require changes to
109-
existing code. Note that this package is different to the legacy humanize
110-
package, which is compatible with existing code.
111-
11294

11395
### Package **tawesoft.co.uk/go/operator:**
11496

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ This is modern code with generics, for go v1.19beta1+
1919
| grace | TODO | - | start and gracefully shutdown processes |
2020
| humanize | TODO | - | locale-aware parsing & formatting of times & quantities |
2121
| ks | [unstable][102] | - | misc helpful things |
22-
| lazy | [candidate][103] | - | composable lazy sequences |
22+
| lazy | [unstable][103] | - | composable lazy sequences |
2323
| loader | [unstable][105] | - | concurrent dependency graph solver |
24-
| numbers | [candidate][106] | - | helpful things for number types |
24+
| numbers | [unstable][106] | - | helpful things for number types |
2525
| text/ccc | [candidate][107] | - | Unicode Canonical Combining Class values |
2626
| text/dm | [candidate][108] | - | Unicode decomposition mappings & selective decompositions |
2727
| text/fallback | [candidate][109] | - | Unicode Character Fallback Substitutions |
@@ -57,6 +57,6 @@ Use the [tawesoft/golib issue tracker](), powered by GitHub issues.
5757
### Commercial Support
5858

5959
Open source software from Tawesoft® is backed by commercial support options.
60-
Email [open-source@tawesoft.co.uk](mailto:open-source@tawesoft.co.uk) or visit
60+
Email [opensource@tawesoft.co.uk](mailto:opensource@tawesoft.co.uk) or visit
6161
[tawesoft.co.uk/products/open-source-software](https://www.tawesoft.co.uk/products/open-source-software)
6262
to learn more.

SECURITY.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,21 @@ used by a large volume of users. Email us with the subject
2222

2323
## Backporting fixes
2424

25-
Applicable security fixes will always be backported to legacy
26-
packages, to the previous two major versions of normal packages, and the
27-
previous one major version of candidate packages.
25+
Applicable security fixes will always be backported to all legacy and stable
26+
packages, where possible. Fixes will be backported to candidate and unstable
27+
packages on a case-by-case basis.
2828

29-
Security fixes may not always be backwards compatible, even between minor
30-
versions.
29+
Security fixes may break backwards compatibility, even between minor versions,
30+
if necessary.
3131

3232

3333
## Reporting a vulnerability
3434

3535
Please disclose responsibly so that we can notify the users of our software
3636
with a fix and/or instructions, including a pre-announcement where appropriate.
3737
Do not report security issues through the public issue tracker in the first
38-
instance, unless it is being actively exploited in the wild.
38+
instance, unless the vulnerability is being actively exploited in the wild or
39+
is already public knowledge.
3940

4041
Instead, please email information about vulnerabilities to
4142
@@ -51,5 +52,6 @@ For example:
5152
If you don't receive an acknowledgement within 48 hours, please contact us
5253
through any contact method listed on the Tawesoft website.
5354

54-
If we have not fixed or disclosed a vulnerability after 90 days, then you may
55-
reserve your right to disclose this publicly.
55+
If, after being notified, we have not fixed or disclosed a vulnerability after
56+
90 days, then you may exercise your right to disclose it publicly.
57+

0 commit comments

Comments
 (0)