You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,20 +3,20 @@ Thanks for your interest in plotly.js!
3
3
### Translations:
4
4
5
5
- Please @ mention a few other speakers of this language who can help review your translations.
6
-
- If you've omitted any keys from [dist/translation_keys.txt](https://github.com/plotly/plotly.js/blob/master/dist/translation-keys.txt) - which means they will fall back on the US English text - just make a short comment about why in the PR description: the English text works fine in your language, or you would like someone else to help translating those, or whatever the reason.
6
+
- If you've omitted any keys from [dist/translation_keys.txt](https://github.com/plotly/plotly.js/blob/main/dist/translation-keys.txt) - which means they will fall back on the US English text - just make a short comment about why in the PR description: the English text works fine in your language, or you would like someone else to help translating those, or whatever the reason.
7
7
- You should only update files in `lib/locales/`, not those in `dist/`
8
8
9
9
### Features, Bug fixes, and others:
10
10
11
11
Before opening a pull request, developer should:
12
-
1. make sure they are not on the `master` branch of their fork as using `master` for a pull request would make it difficult to fetch `upstream` changes.
13
-
2. fetch latest changes from `upstream/master` into your fork i.e. `origin/master` then pull `origin/master` from you local `master`.
14
-
3. then `git rebase master` their local dev branch off the latest `master` which should be sync with `upstream/master` at this time.
12
+
1. make sure they are not on the `main` branch of their fork as using `main` for a pull request would make it difficult to fetch `upstream` changes.
13
+
2. fetch latest changes from `upstream/main` into your fork i.e. `origin/main` then pull `origin/main` from you local `main`.
14
+
3. then `git rebase main` their local dev branch off the latest `main` which should be sync with `upstream/main` at this time.
15
15
4. make sure to **not**`git add` the `dist/` folder (the `dist/` is updated only on version bumps).
16
16
5. make sure to commit changes to the `package-lock.json` file (if any new dependency required).
17
17
6. provide a title and write an overview of what the PR attempts to do with a link to the issue they are trying to address.
18
18
7. select the _Allow edits from maintainers_ option (see this [article](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) for more details).
19
19
20
20
After opening a pull request, developer:
21
-
- should create a new small markdown log file using the PR number e.g. `1010_fix.md` or `1010_add.md` inside `draftlogs` folder as described in this [README](https://github.com/plotly/plotly.js/blob/master/draftlogs/README.md), commit it and push. A CI check enforces this; PRs that don't warrant a CHANGELOG entry can opt out by applying the `no-draftlog` label.
22
-
- should **not** force push (i.e. `git push -f`) to remote branches associated with opened pull requests. Force pushes make it hard for maintainers to keep track of updates. Therefore, if required, please fetch `upstream/master` and "merge" with master instead of "rebase".
21
+
- should create a new small markdown log file using the PR number e.g. `1010_fix.md` or `1010_add.md` inside `draftlogs` folder as described in this [README](https://github.com/plotly/plotly.js/blob/main/draftlogs/README.md), commit it and push. A CI check enforces this; PRs that don't warrant a CHANGELOG entry can opt out by applying the `no-draftlog` label.
22
+
- should **not** force push (i.e. `git push -f`) to remote branches associated with opened pull requests. Force pushes make it hard for maintainers to keep track of updates. Therefore, if required, please fetch `upstream/main` and "merge" with main instead of "rebase".
Copy file name to clipboardExpand all lines: BUILDING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Alternative ways to require or build plotly.js
2
-
Depending on your needs you may require/import one of [the distributed plotly.js packages](https://github.com/plotly/plotly.js/blob/master/dist/README.md) or [a plotly.js/lib index file](https://github.com/plotly/plotly.js/tree/master/lib) and integrate it into your application.
2
+
Depending on your needs you may require/import one of [the distributed plotly.js packages](https://github.com/plotly/plotly.js/blob/main/dist/README.md) or [a plotly.js/lib index file](https://github.com/plotly/plotly.js/tree/main/lib) and integrate it into your application.
3
3
4
4
The sections below provide additional info in respect to alternative building frameworks.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,7 +97,7 @@ cd plotly.js
97
97
#### Step 2: Switch to a dev branch
98
98
99
99
```bash
100
-
# please do not use master or main for your dev branch
100
+
# please do not use main for your dev branch
101
101
git checkout dev-branch-name
102
102
```
103
103
@@ -138,7 +138,7 @@ comes bundled with some useful tools while developing - all bundled under the
138
138
|`Tabs.onReload()`| By default, set to `noop` but you may set `Tabs.onReload` to any function you wish. This is useful for replotting a mock or test every time you reload the plotly.js script. |
139
139
|`Tabs.purge()`| Destroys all plots. |
140
140
141
-
View [the source](https://github.com/plotly/plotly.js/blob/master/devtools/test_dashboard/devtools.js) for more info.
141
+
View [the source](https://github.com/plotly/plotly.js/blob/main/devtools/test_dashboard/devtools.js) for more info.
142
142
143
143
Three additional helpers exist that are refreshed every second:
144
144
@@ -205,7 +205,7 @@ previous changes. `npm run regl-codegen` will prompt you to open
205
205
a browser window, run through the mocks for each regl-using trace
206
206
(`parcoords`, `scattergl`, `scatterpolargl`, `splom`), and store the captured
Copy file name to clipboardExpand all lines: CUSTOM_BUNDLE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Custom bundle
2
-
You can easily make custom bundles yourself if none of the [distributed packages](https://github.com/plotly/plotly.js/blob/master/dist/README.md) meet your needs, or if you want to make a more optimized bundle file with/without specific traces.
2
+
You can easily make custom bundles yourself if none of the [distributed packages](https://github.com/plotly/plotly.js/blob/main/dist/README.md) meet your needs, or if you want to make a more optimized bundle file with/without specific traces.
3
3
4
4
Make sure you have the versions of node/npm that's recommended:
[Plotly.js](https://plotly.com/javascript) is a standalone JavaScript data visualization library, and it also powers the Python and R modules named `plotly` in those respective ecosystems (referred to as [Plotly.py](https://plotly.com/python) and [Plotly.R](http://plotly.com/r)).
8
8
@@ -38,7 +38,7 @@ Plotly.js can be used to produce dozens of chart types and visualizations, inclu
@@ -121,12 +121,12 @@ You may simply load the [virtual-webgl](https://github.com/greggman/virtual-webg
121
121
122
122
## Bundles
123
123
There are two kinds of plotly.js bundles:
124
-
1. Complete and partial official bundles that are distributed to `npm` and the `CDN`, described in [the dist README](https://github.com/plotly/plotly.js/blob/master/dist/README.md).
125
-
2. Custom bundles you can create yourself to optimize the size of the bundle depending on your needs. Please visit [CUSTOM_BUNDLE](https://github.com/plotly/plotly.js/blob/master/CUSTOM_BUNDLE.md) for more information.
124
+
1. Complete and partial official bundles that are distributed to `npm` and the `CDN`, described in [the dist README](https://github.com/plotly/plotly.js/blob/main/dist/README.md).
125
+
2. Custom bundles you can create yourself to optimize the size of the bundle depending on your needs. Please visit [CUSTOM_BUNDLE](https://github.com/plotly/plotly.js/blob/main/CUSTOM_BUNDLE.md) for more information.
126
126
127
127
---
128
128
## Alternative ways to load and build plotly.js
129
-
If your library needs to bundle or directly load [plotly.js/lib/index.js](https://github.com/plotly/plotly.js/blob/master/lib/index.js) or parts of its modules similar to [index-basic](https://github.com/plotly/plotly.js/blob/master/lib/index-basic.js) in some other way than via an official or a custom bundle, or in case you want to tweak the default build configurations, then please visit [`BUILDING.md`](https://github.com/plotly/plotly.js/blob/master/BUILDING.md).
129
+
If your library needs to bundle or directly load [plotly.js/lib/index.js](https://github.com/plotly/plotly.js/blob/main/lib/index.js) or parts of its modules similar to [index-basic](https://github.com/plotly/plotly.js/blob/main/lib/index-basic.js) in some other way than via an official or a custom bundle, or in case you want to tweak the default build configurations, then please visit [`BUILDING.md`](https://github.com/plotly/plotly.js/blob/main/BUILDING.md).
130
130
131
131
---
132
132
## Documentation
@@ -139,12 +139,12 @@ For more info about contributing to Plotly documentation, please read through [c
139
139
---
140
140
## Bugs and feature requests
141
141
142
-
Have a bug or a feature request? Please [open a Github issue](https://github.com/plotly/plotly.js/issues/new) keeping in mind the [issue guidelines](https://github.com/plotly/plotly.js/blob/master/.github/ISSUE_TEMPLATE.md). You may also want to read about [how changes get made to Plotly.js](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md).
142
+
Have a bug or a feature request? Please [open a Github issue](https://github.com/plotly/plotly.js/issues/new) keeping in mind the [issue guidelines](https://github.com/plotly/plotly.js/blob/main/.github/ISSUE_TEMPLATE.md). You may also want to read about [how changes get made to Plotly.js](https://github.com/plotly/plotly.js/blob/main/CONTRIBUTING.md).
143
143
144
144
---
145
145
## Contributing
146
146
147
-
Please read through our [contributing guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md). Included are directions for opening issues, using plotly.js in your project and notes on development.
147
+
Please read through our [contributing guidelines](https://github.com/plotly/plotly.js/blob/main/CONTRIBUTING.md). Included are directions for opening issues, using plotly.js in your project and notes on development.
148
148
149
149
---
150
150
## Notable contributors
@@ -182,7 +182,7 @@ Plotly.js is at the core of a large and dynamic ecosystem with many contributors
182
182
183
183
Code and documentation copyright 2025 Plotly, Inc.
184
184
185
-
Code released under the [MIT license](https://github.com/plotly/plotly.js/blob/master/LICENSE).
185
+
Code released under the [MIT license](https://github.com/plotly/plotly.js/blob/main/LICENSE).
0 commit comments