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

Update documentation #12

Merged
merged 6 commits into from
Sep 11, 2020
Merged

Update documentation #12

merged 6 commits into from
Sep 11, 2020

Conversation

dominykas
Copy link
Member

@dominykas dominykas commented Aug 28, 2020

Adding the missing docs and expanding existing ones.

Closes #5

@dominykas dominykas marked this pull request as draft August 28, 2020 15:44
Signed-off-by: Dominykas Blyžė <hello@dominykas.com>
Signed-off-by: Dominykas Blyžė <hello@dominykas.com>
Signed-off-by: Dominykas Blyžė <hello@dominykas.com>
Signed-off-by: Dominykas Blyžė <hello@dominykas.com>
Signed-off-by: Dominykas Blyžė <hello@dominykas.com>
```
- **[`all`](./all)** - new major releases get added as they are released, they never get removed
- **[`lts`](./lts)** - new major releases get added as they are released, non-LTS releases get removed when their support lifetime ends, LTS versions never get removed
- **[`lts/strict`](./lts/strict)** - new major releases get added as they reach LTS status, they never get removed
Copy link
Member

Choose a reason for hiding this comment

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

Wondering if there is value in adding support for the other aliases?

Copy link
Member Author

Choose a reason for hiding this comment

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

I considered that, but they'd have identical contents with the ones here, given the "we won't remove versions" guarantee.


## Including the minimum supported version

The shared configurations only define a list of major versions, which means Travis CI will execute your tests in the _latest_ version of each major release line. If you intend your code to work in earlier versions of that release line, you _should_ explicitly include the earliest version you support in your test matrix, e.g. append the following in your `.travis.yml`:
Copy link
Contributor

Choose a reason for hiding this comment

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

👍🏼

README.md Outdated Show resolved Hide resolved
Co-authored-by: Matt Travi <github@travi.org>
Signed-off-by: Dominykas Blyžė <hello@dominykas.com>
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

@dominykas dominykas merged commit 80a9b38 into nodejs:master Sep 11, 2020
@dominykas dominykas deleted the update-readmes branch September 11, 2020 07:16
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.

Repo layout bikeshed
4 participants