Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
docs: tutorial on how to submit a pull request to lb4 #2364
Currently, the intention is to link to this tutorial document from the "Contributing to Loopback"
sidebar which is defined in the
In the online documentation it is this link : https://loopback.io/doc/en/contrib/doc-contrib.html
If this is agreed upon by everyone, then I will create a PR for that change in the
referenced this pull request
Feb 10, 2019
@bajtos , regarding
I was wondering if we should have the user
Will they be using any of these afterwards...if everything is fine?
This article, mentioned in #2280, https://www.nearform.com/blog/getting-into-open-source-for-the-first-time/, has some clean up steps at the end. Deleting the feature branch of the forked repo, and then rebasing so the master branch of the forked repo is up to date with original repo. But what is the point? Isn't it cleaner and more efficient to delete everything that is no longer needed? I would appreciated your feedback in this matter. thanks. :)
@raymondfeng @bajtos @dhmlau , when someone first creates the pull request, is it important that
Then, during the review phase, the contributor adds more commits with messages.
Then, at the end, there is a final
The reason I am asking is because I want to know if the
I know that if I were a maintainer, I would like to look at 1 commit, and 1 commit message...at least initially.
This article, https://www.nearform.com/blog/getting-into-open-source-for-the-first-time/, mentioned in #2280, also mentions rebasing just before creating a pull request.
He doesn't mention squashing commits, however.
Today I spoke with Biniam , @b-admike , about this and he clarified a few things. My latest commit has my changes.
There are different point in time that the user needs to rebase and squash the commits. Here are my thoughts:
Suggest that you link directly to Contributing code/LoopBack 4 (https://loopback.io/doc/en/contrib/code-contrib-lb4.html) in Step 9. The Contributing code link can open the LB4 page. Currently it links to (http://localhost:4001/doc/en/contrib/code-contrib.html, a 3.x page.
I like the detailed walkthrough for github newbies. But 18 steps is scary :-). Please separate the ones that are common to all github repos from those extras/specifics for loopback-next. At the top of the tutorial, allow fluent github users to go directly to our special requirements.
Let's think about how many mins are needed to read and how many steps to go through. It’s critical to keep them minimal. Use the TL;DR style if necessary.
By our experience, most users struggle with or do not pay attention to the following:
These are the pain points that deserve more words/diagrams.
@b-admike , concerning