Skip to content

improve CONTRIBUTING and describe how to clone from your fork #5791

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jul 17, 2021
Merged

improve CONTRIBUTING and describe how to clone from your fork #5791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0c3a0ae
improve CONTRIBUTING how to clone from your fork
archmoj Jun 30, 2021
be30fc9
Merge remote-tracking branch 'origin/master' into how-to-clone-your-fork
archmoj Jul 7, 2021
c2166df
draft log for PR 5791
archmoj Jul 7, 2021
113c996
adjust contributing
archmoj Jul 13, 2021
b62be42
Merge remote-tracking branch 'origin/master' into how-to-clone-your-fork
archmoj Jul 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,21 +84,33 @@ We use the following [labels](https://github.com/plotly/plotly.js/labels) to tra
[`package-lock.json`](https://docs.npmjs.com/files/package-lock.json) file is
used and updated correctly.

#### Step 1: Clone the plotly.js repo and install its dependencies
#### Step 1: Fork the plotly.js repository, clone your fork and step into it

```bash
git clone https://github.com/plotly/plotly.js.git
git clone --depth 1 git@github.com:<your-GitHub-username>/plotly.js.git
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is --depth 1 important enough to warrant including here? I could imagine it occasionally being dangerous, like if the user wanted to pick up an old branch and complete the work.

Also, in #5780 we talk about origin and upstream, do we want to discuss how to set that up?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is --depth 1 important enough to warrant including here? I could imagine it occasionally being dangerous, like if the user wanted to pick up an old branch and complete the work.

I thought it will make it easier for the people to contribute, instead of pulling down the whole history of plotly.js.
Curious to know what @nicolaskruchten thinks here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, in #5780 we talk about origin and upstream, do we want to discuss how to set that up?

fetch-upstream
It appears GitHub recently added a new button which made the process of fetching upstream way easier.

cd plotly.js
```

#### Step 2: Switch to a dev branch

```bash
# please do not use master or main for your dev branch
git checkout dev-branch-name
```

#### Step 3: Install dependencies

```bash
npm install
```

#### Step 2: Setup test environment
#### Step 4: Setup test environment

```bash
npm run pretest
```

#### Step 3: Start the test dashboard
#### Step 5: Start the test dashboard

```bash
npm start
Expand All @@ -110,7 +122,7 @@ This command bundles up the source files with source maps using
dev plotly.js bundle update every time a source file is saved) and opens up a
tab in your browser.

#### Step 4: Open up the console and start developing
#### Step 6: Open up the console and start developing

A typical workflow is to make some modifications to the source, update the
test dashboard, inspect and debug the changes, then repeat. The test dashboard
Expand Down Expand Up @@ -138,13 +150,13 @@ Three additional helpers exist that are refreshed every second:
There is also a search bar in the top right of the dashboard. This fuzzy-searches
image mocks based on their file name and trace type.

#### Step 5: Regenerate plot-schema in "test" folder then review & commit potential changes
#### Step 7: Regenerate plot-schema in "test" folder then review & commit potential changes

```bash
npm run schema
```

#### Step 6: Review & commit potential changes made to test/plot-schema.json
#### Step 8: Review & commit potential changes made to test/plot-schema.json

> If you are editing attribute descriptions or implementing a new feature this file located in the test folder records the proposed changes to the API. Note that there is another plot-schema.json file located in the dist folder, which should only be updated by the maintainers at release time.

Expand Down
1 change: 1 addition & 0 deletions draftlogs/5791_change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Adjust CONTRIBUTING document on how to clone plotly.js and submit pull requests from your fork [[#5791](https://github.com/plotly/plotly.js/pull/5791)]