12/27/2023 0 Comments Git change branch tomcat![]() If this concept is new to you read “ Section 1: Getting the Source Code” in that article before you actually do a Fork. In an earlier installment of the “It’s Easy!” series, “ It’s Easy! Get the TomEE Source Code and Join the Community”, we covered in detail how to create a GitHub account and Fork the TomEE project. The first operation in the sequence is to Fork the project as shown below. I put together a sequence diagram for Step 1, “Fork, Clone, Branch”, to help understand the process better. In our case, we don’t want to make a new TomEE community, we simply want to get our own copy of the TomEE project so that we don’t accidentally cause problems with the main project. Linux, BSD, Mac OS X) which are sometimes called Forks. For example, there are many different Unix-like operating systems (e.g. When I first learned about “Forking” a GitHub project I thought it was synonymous with “Forking” an entire community. All this sounds more complicated than it actually is so don’t be intimidated. To Branch is to create a version of your clone that you can modify and then submit to be included in the main TomEE repository using what is called a Pull-Request. To Clone means to copy your fork of the TomEE repository to your personal computer so that you can work on it locally. To Fork means to copy the Apache TomEE project to your own GitHub account so that you can work on the project without interfering with the work of others. “Fork, Clone, Branch” is the mantra of every contributor making changes to the TomEE code base or documentation. Let’s cover each step in detail so that you know exactly what to do when you have been assigned a JIRA task. The Process Task portion of the Contribution Workflow has five steps: Fork-Clone-Branch, Mark JIRA InProgress, Ask Questions, Do-the-Work, and Document-the-Work. The following diagram shows how the Process Task portion of the Contribution Workflow fits into the whole. This is where the rubber meets the road where the actual work of writing or coding a solution takes place. The Process Task portion of the Contribution Workflow is where you do the work on an issue (bug fixes, enhancements, tests, documentation) after getting assigned a JIRA ticket. After you are done with your work there are some things you need to do to clean up and leave the place nice and tidy for the next person. It’s the less exciting but all too necessary part of the process. Cleaning up after you are done contributing code is like doing the dishes after serving a wonderful dinner. This is the last stage in the process and is just as important as any other. This is ultimately your goal: To produce code that improves TomEE and is included in the project. This is where your work is actually added to the TomEE code-base or documentation. In this part, you make sure that your code compiles and passes unit tests and then you submit what is called a “Pull-Request” (PR) asking for your work to be reviewed and added to the TomEE project. The Process Task is the subject of this article and is covered in detail starting in “ Section 2: Process Task”. Where you get the source code or source documentation, do the work, and document that work in a JIRA ticket. The JIRA Ticket sub-process was covered in detail in the article “ It’s Easy! Your First TomEE Pull-Request: Using JIRA.” 1.2 Process Task This sub-process shows how to find issues to work on and the process for initiating work on those issues. In TomEE we try to ensure that every bit of work is identified and detailed in JIRA tickets. The JIRA Ticket sub-process is all about discovering issues that need work. Before we get started a quick review of all the processes can be helpful – if you know it already then feel free to skip ahead to Section 2. In this article, we are going to take a deep dive into “Process Task”. In the last installment, we covered the “JIRA Ticket” sub-process in detail. The Contribution Workflow includes five sub-processes: JIRA Ticket, Process Task, Submit Changes, Merge Changes and Clean up. ![]() ![]() TomEE has a process called the Contribution Workflow that we follow to ensure that everyone is on the same page and that everything is clear and open. Section 1: The Contribution Workflow Overview This article, broken up into two parts, shows you how to get set up so you can start contributing and how to use Git to preserve your changes and save them up to your GitHub account. In the last installment, “ It’s Easy! Your First TomEE Pull-Request: Using JIRA”, we showed you how to discover and get assigned a task in the TomEE open source project. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |