From 2b112b2cc27e50bbb6f1b965c8b86be1178dedfe Mon Sep 17 00:00:00 2001 From: Ib Green Date: Sun, 4 Aug 2024 08:36:13 -0400 Subject: [PATCH] chore: update publish scripts (#123) --- docs/CONTRIBUTING.md | 50 +++++++++++++++++++++++ docs/README.md | 8 +++- docs/modules/arrow-layers/README.md | 2 +- docs/modules/bing-maps/README.md | 2 +- docs/modules/editable-layers/README.md | 2 +- docs/modules/experimental/README.md | 2 +- docs/modules/graph-layers/README.md | 2 +- docs/modules/layers/README.md | 2 +- docs/modules/react-graph-layers/README.md | 2 +- docs/modules/react/README.md | 2 +- package.json | 3 +- website/src/docs-sidebar.js | 2 +- 12 files changed, 67 insertions(+), 12 deletions(-) create mode 100644 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 00000000..93ed5107 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing + +## Preliminaries + +Bug fixes are highly encouraged! + +For feature extensions to existing modules, it is generally recommended to start a discussion before you open a PR. + +If you have a new module that you think could fit into this repository, please start by opening a GitHub issue to start a discussion, or reach out in the OpenJS slack. +Note that for a new module you will also be asked to asses what level of maintenance you will be able to provide over the longer term. + +## Preparations + +Most work is done on master. + +## Review + +Open Visualization team members will make efforts to review your PRs. +As always, clean and focused PRs that do one thing only will be approved and landed faster. Instead of including an unrelated one line fix, consider making a second small PR. + +## Landing PRs + +Once comments are addressed and the CI tests on GitHub run clean, your PR will be landed by an Open Visualization team member. + +## Closing PRs + +PRs that do not receive updates to comments for one or two days will be closed, for "repository hygiene" reasons. + +If this happens to you and you are coming back to address the PR, just reopen it once you have pushed your changed. + +## Fixing CI issues + +Unfortunately, many good PRs are closed. By far the most common reason is that the authors can't be bothered to make CI run clean. + +Note that CI can usually be fixed in 1-2 minutes as follows: + +- `yarn lint fix` - will run `prettier` and `eslint --fix` and fixes 95% of failed CI checks. +- `yarn` - also make sure you run `yarn` to update `yarn.lock` after making changes depdencies in any `package.json` files. For security reasons, GitHub CI will reject your PR if your `yarn.lock` file is out of date with your `package.json` files. + +After running these commands just commit and push your PR again and it will likely run green. + +## Publishing new versions + +Open Visualization team members will make efforts to publish new versions once your PRs land. A good cadence is a weekly patch with any accumulated fixes. + +## Official contributors + +If you regularly contribute to one of the modules, you may be granted write access to the deck.gl-community GitHub repository allowing you e.g. sto push branches directly instead of working via a GitHub fork. + +This is decided by the Open Visualization Technical Steering committee and is based on trust, merit and scope of contributions. diff --git a/docs/README.md b/docs/README.md index dc883721..cadec98c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,10 @@ # Introduction This repository contains a collection of "community supported" modules for [deck.gl](https://deck.gl). -It was created to provide a home for a number of excellent deck.gl add-on modules that no longer have active maintainers, with the hope that community contributions will keep them alive +deck.gl-community was created to provide a home for a number of excellent deck.gl add-on modules that no longer have active maintainers, with the hope that community contributions will keep them alive. :::danger -The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module. +The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you. ::: ## Scope @@ -45,6 +45,10 @@ For feature extensions to existing modules, it is generally recommended to start If you have a new module that you think could fit into this repository, please start by opening a GitHub issue to start a discussion, or reach out in the OpenJS slack. Note that for a new module you will also be asked to asses what level of maintenance you will be able to provide over the longer term. +## Maintainers + +We are always looking for long-term or short-term maintainers. If you'd like to work on one of these modules, even if only temporarily, the Open Visualization team is ready to welcome and support you. + ## Governance Final decisions ultimately rest with the OpenJS Open Visualization TSC (Technical Steering Committee), but decisions are often made in the bi-weekly Linux Foundation / OpenJS OpenVisualization meetings which are open to anyone. diff --git a/docs/modules/arrow-layers/README.md b/docs/modules/arrow-layers/README.md index d762faa9..82b0dc8a 100644 --- a/docs/modules/arrow-layers/README.md +++ b/docs/modules/arrow-layers/README.md @@ -1,7 +1,7 @@ # Overview :::danger -The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module. +The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you. ::: :::danger diff --git a/docs/modules/bing-maps/README.md b/docs/modules/bing-maps/README.md index 8a229a9d..ab078e56 100644 --- a/docs/modules/bing-maps/README.md +++ b/docs/modules/bing-maps/README.md @@ -1,7 +1,7 @@ # Overview :::danger -The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module. +The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you. ::: This module allows [deck.gl](https://deck.gl) to be used as a Bing Maps custom layer. diff --git a/docs/modules/editable-layers/README.md b/docs/modules/editable-layers/README.md index b7bc010b..03f68246 100644 --- a/docs/modules/editable-layers/README.md +++ b/docs/modules/editable-layers/README.md @@ -1,7 +1,7 @@ # Overview :::danger -The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module. +The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you. ::: diff --git a/docs/modules/experimental/README.md b/docs/modules/experimental/README.md index bbbd4f06..76e36b79 100644 --- a/docs/modules/experimental/README.md +++ b/docs/modules/experimental/README.md @@ -1,7 +1,7 @@ # Overview :::danger -The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module. +The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you. ::: ![deck.gl v9](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square") diff --git a/docs/modules/graph-layers/README.md b/docs/modules/graph-layers/README.md index 5bd322e1..f1c948fc 100644 --- a/docs/modules/graph-layers/README.md +++ b/docs/modules/graph-layers/README.md @@ -1,7 +1,7 @@ # Overview :::danger -The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module. +The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you. ::: ![deck.gl v9](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square") diff --git a/docs/modules/layers/README.md b/docs/modules/layers/README.md index ebe93daf..781eefea 100644 --- a/docs/modules/layers/README.md +++ b/docs/modules/layers/README.md @@ -1,7 +1,7 @@ # Overview :::danger -The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module. +The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you. ::: ![deck.gl v9](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square") diff --git a/docs/modules/react-graph-layers/README.md b/docs/modules/react-graph-layers/README.md index 565029f3..557668e7 100644 --- a/docs/modules/react-graph-layers/README.md +++ b/docs/modules/react-graph-layers/README.md @@ -1,7 +1,7 @@ # Overview :::danger -The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module. +The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you. ::: :::danger diff --git a/docs/modules/react/README.md b/docs/modules/react/README.md index 72198073..e0e32ccb 100644 --- a/docs/modules/react/README.md +++ b/docs/modules/react/README.md @@ -1,7 +1,7 @@ # Overview :::danger -The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module. +The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you. ::: A collection of generic react components to use with deck.gl diff --git a/package.json b/package.json index 29657bbc..c6d8c6f0 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,8 @@ "lint": "ocular-lint", "lint-fix": "ocular-lint --fix", "prepublishOnly": "ocular-build && node -e \"const fs = require('fs'); const pkg = JSON.parse(fs.readFileSync('./package.json', {encoding: 'utf8'})); delete pkg.engines; fs.writeFileSync('package.json', JSON.stringify(pkg, null, 2)); console.log(pkg)\"", - "publish": "ocular-publish", + "publish-beta": "ocular-publish beta", + "publish-prod": "ocular-publish prod", "test": "lerna run test", "test-ci": "ocular-lint && lerna run test", "test-fast": "lerna run test", diff --git a/website/src/docs-sidebar.js b/website/src/docs-sidebar.js index bbbe4dbe..2bfd19ad 100644 --- a/website/src/docs-sidebar.js +++ b/website/src/docs-sidebar.js @@ -26,7 +26,7 @@ const sidebars = { { type: 'category', label: 'Overview', - items: ['README', 'whats-new', 'upgrade-guide'] + items: ['README', 'whats-new', 'upgrade-guide', 'CONTRIBUTING'] }, { type: 'category',