joomla/Component-Builder
joomla/Component-Builder
39
23
Fork 11
Code Issues 80 Pull Requests Projects 4 Wiki Activity

Updated 048 Tutorial on making a pull request at Joomla Component Builder Snippets (markdown)

Amigo 2019-08-30 11:13:03 +02:00
parent 23e2cae0fb
commit 25162c0031
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
048-Tutorial-on-making-a-pull-request-at-Joomla-Component-Builder-Snippets.md

@ -38,32 +38,30 @@ This is the page where it starts. Click on this 'Create pull request'. This will
[00:05:43](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h05m43s)
I am just going to write: 'Demonstration of snippet contribution'. You will not be able to make changes here. It is only the admin that has the ability to add in 'Reviewer', 'Assign', 'Label', 'Project' and 'Milestone'. That will be the responsibility of the admin. They might not do it but if it is a big contribution we might probably make use of these tools. <<<<<<<<<<<
I am just going to write: 'Demonstration of snippet contribution'. You will not be able to make changes here. It is only the admin that can add in 'Reviewer', 'Assign', 'Label', 'Project' and 'Milestone'. That will be the responsibility of the admin. They might not do it but if it is a big contribution we might probably make use of these tools.
### Description - Use Commit Messages
[00:06:27](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h06m27s)
The description, we could either just use the commit messages as the description or like I said that which we will maybe set up in the future. We will then create the pull request and just give another glance and say: everything is fine, click 'Create pull request'. We now have the pull request and here is where we as the admin will get involved. You cannot really take it further and rightly because we want to protect this repository. We want to make sure only good [00:07:17](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m17s) well-documented, well explained, well named, snippets are contributed. Once you have come to this point, you'll have to wait for one of our admin to get back to you and if they have issues, they will start discussing it with you. Ask questions and please we want to [00:07:40](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m40s) protect you and protect everyone else. So don't be upset if they have questions. In fact, be glad that they would that will ensure that all of us will enjoy this infrastructure. Once everything is satisfied and everyone is happy there will be some reviewers that will sign off on this pull request. [00:08:05](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h08m05s) At this stage if we have two reviewers sign off on it, at least then we can merge it into the master branch.
The commit messages can be used as the 'Description' or that which we will maybe set up in the future. We will create a pull request and just give another glance at it to see that everything is fine, click 'Create pull request'. We now have the pull request and it is here where the admin will get involved. You cannot take it further and rightly because we want to protect this repository. We want to make sure only good well-documented, well explained, well named, snippets are contributed.[00:07:17](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m17s) Once you have come to this point, you will have to wait for one of our admin to get back to you and if they have issues, they will start discussing it with you and ask questions. [00:07:40](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m40s) We want to protect you and protect everyone else, so do not be upset if they have questions. Be glad that they would, that will ensure that all of us will enjoy this infrastructure. Once everyone is satisfied there will be some reviewers that will sign off on this pull request. [00:08:05](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h08m05s) At this stage if we have two reviewers sign off on it, at least then we can merge it into the master branch.
### Different Ways To Merge Into The Master Branch
[00:08:19](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h08m19s)
Now there are different ways of how the merging into the master branch is done. This is mostly related and I'm doing this part mostly for the admin, who may need to be able to do this. You could do it here on GitHub. Just click 'Merge pull request'. Since there are no conflicts, if there are conflicts then it gets more complicated and usually, we will need more advanced admin guys who know Git better to maybe in a command-line be able to resolve some of this.
Now there are different ways of how the merging into the master branch is done. I am doing this part mostly for the admin, who may need to be able to do this. You could do it here on GitHub. Just click 'Merge pull request'. Since there are no conflicts, if there are conflicts then it gets more complicated and usually, we will need more advanced admin guys who know Git better to maybe in a command-line resolve some of this.
### Command Line Instructions
[00:08:54](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h08m54s)
You can click on 'command-line instructions' link and it will show you the command line way of dealing with it. Or you could select one of these various emerging options. All of that I'll explain more in a tutorial that's just specifically directed [00:09:12](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m12s) at the further steps that are necessary for admins. Where us regarding you as a contributor, this is really where you end and we take over. We want to tell you that once the contribution is accepted and it's merged in, then it will again become visible [00:09:35](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m35s) in JCB, in the Snippet Get area, which we demonstrated when we started out giving an overview of how things work. And really that's what it's about, it's really all of this complexity that we've now discussed, is not the main focus.
You can click on 'command-line instructions' link and it will show you the command line way of dealing with it or you could select one of these various merging options. This will be explained in a tutorial that is specifically directed at the further steps that are necessary for admins. [00:09:12](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m12s) Whereas regarding you as a contributor, this is really where you end and we take over. We want to tell you once the contribution is accepted is merged in, it will again become visible in JCB, in the Snippet Get area, which we demonstrated when we gave an overview of how things work. [00:09:35](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m35s)
### Focus - Managing Snippets
[00:09:52](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m52s)
The focus is to enable us to enlarge the Snippet area without really intruding bond constant updates in database tricks to share the Snippets. But instead, have this easy way of maintaining a GitHub repository. Which in effect will then be accessible via the JCB Get area. When you can add new Snippets. You can obviously delete Snippets, [00:10:24](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h10m24s) and going to the Snippets area. You can come in Snippets and click Accordion and Trash the snippet. Then go to Trashed and completely delete the snippet(Accordion) from your repository which will then cause the snippet to [00:10:45](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h10m45s) be seen as non-existent in your Snippets area. There are ways to remove duplicates. I don't want to go into a very long explanation again on how the Snippets area works. But our expectation is that some of you would feel I want to contribute, Share Snippets with the rest of the community and at the same time get your name out there. Since looking at the files changed, [00:11:14](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h11m14s) you will see that this new snippet, it looks like it just did what it's been doing, because my name is on most of these, is because I added them and that's why my name is on there. You are also able to add your name in here because you are adding Snippets and that's really the idea. [00:11:37](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h11m37s) I'm looking forward to seeing all of you getting involved in this area as well.
The focus is to enable us to enlarge the Snippet area without really intruding on bond-constant-updates in database tricks to share the Snippets. But instead, have this easy way of maintaining a GitHub repository, which in effect will then be accessible via the JCB Get area where you can add new Snippets. You can delete Snippets, [00:10:24](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h10m24s) and go to the Snippets area and come in Snippets and click 'Accordion' and 'Trash' the snippet. Then go to 'Trashed' and completely delete the snippet(Accordion) from your repository which will then cause the snippet to [00:10:45](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h10m45s) be seen as non-existent in your Snippets area. There are ways to remove duplicates.
Share Snippets with the rest of the community and at the same time get your name out there. Since looking at the files changed, you will see that this new snippet, it seems like it just did what it was supposed to do. Because my name is on most of these, it is because I added them and that is why my name is on there. You are also able to add your name in here because you are adding Snippets. [00:11:37](https://www.youtube.com/watch?v=vQ-yxVtc-Co&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h11m37s) I am looking forward to seeing all of you getting involved in this area as well.