Page Comparison

...

For the starter ticket, everyone will be adding their name to the credits page! This document will take you step by step through the entire process: creating your ticket, creating your branch, making changes, making commits, pushing changes, and creating a pull request. Once you have made the pull request and we’ve reviewed it and merged it, then you will be assigned a Tech Lead and can start working on tickets from our project board.

...

Create the Ticket

In the repository, you will see a tab called Issues. Click on this tab and then click the green "New Issue" button in the top right of the screen. From there, select the "Task" option by clicking "Get Started". This will open the template for a “Task” ticket. Feel free to explore the other tempaltes.

...

Committing Your Code

Once you’ve completed your ticket made the necessary changes and are ready to submit what you have for review, go back into your command line , make sure you are still on the right branch by running git branch, and run the command git add . which will save all the changes you've made, then . Then run git commit -m '#YourIssueNumber ‘#YourIssueNumber Added my name to credits'. For example, #546: added my name to the credits page. Again, the # is important so that GitHub recognizes that you’re working on your issue.

Once you've committed your work, you must push it to the remote site by entering git push. You may need to run git push --set-upstream origin [branch name] as instructed by the git CLI if the branch does not already exist in the GitHub repo and only exists on your local computer.

Creating a Pull Request

Its time to create a Pull Request (PR) so that your code can be reviewed. Go to the repository and select the “Pull Requests” tab. From there, select “New pull request” and make sure that “base” is “develop” and “compare” is the branch you’ve created. Once you’ve selected your branch to compare, select “Create Pull Request.”

For your title you can leave it as the branch name if you’ve properly named it. For the changes, say what you’ve changed! If you struggled at all, let us know in the notes section! We won’t be using the test cases section for this ticket so you can delete it, but if you had written any complex code that needed testing, make sure to show the results here, but for now you can delete this entire section. For screenshots, make sure to take one of the screen when its fill the entire screen, and another one where you make it as small as possible.

You’ve completed the ticket so theres nothing left todo! You can remove this the Todo section as well since there’s nothing left todo. Then finally go over the check list and make sure you’ve completed everything.

On the right side of the screen you will see an option to request a reviewer, you can select any of the tech leads or anthony, then make Anthony. Make sure to assign yourself under the assignee section (just like on the issue page).

Finally at the bottom of your PR you will see “closes #”, enter your issue number next to the #. For example, closes #546. Finally, select "Create Pull Request" and now you've finished! You will know you’ve you've succeeded if on the right side panel under “development”"development", theres a link to your ticket . Finally, select “Create Pull Request” and now you’ve finished! (if there isn’t, you can do it manually).

Wait for somebody to review your code, and if they have any comments make sure to make the changes in your code, and make a new commit with those changes, following the same rules as mentioned before (you do not need to create a new pull request).

Handling Merge Conflicts

...

Resources

For our guidelines on how to contribute to the repo, see the Software Contributor Guide.

For some resources on Git, see the Software Learning Resources page.