Skip to content

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

Merged
archmoj merged 5 commits into
masterfrom
how-to-clone-your-fork
Jul 17, 2021
Merged

improve CONTRIBUTING and describe how to clone from your fork#5791
archmoj merged 5 commits into
masterfrom
how-to-clone-your-fork

Conversation

@archmoj

@archmoj archmoj commented Jun 30, 2021

Copy link
Copy Markdown
Contributor

@plotly/plotly_js

@archmoj
archmoj requested a review from alexcjohnson June 30, 2021 19:03
Comment thread CONTRIBUTING.md

```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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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.

@archmoj
archmoj requested a review from nicolaskruchten July 7, 2021 14:41
Comment thread CONTRIBUTING.md Outdated

@alexcjohnson alexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

💃 we could always bikeshed on this, but it's a clear improvement so let's merge!

@archmoj
archmoj merged commit e683025 into master Jul 17, 2021
@archmoj
archmoj deleted the how-to-clone-your-fork branch July 17, 2021 05:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants