-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update publish scripts (#123)
- Loading branch information
Showing
12 changed files
with
67 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters