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

Changes from 1 commit
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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@ 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: Clone the plotly.js repo, download it and install dependencies

```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
npm install
```
Expand Down