Pull Requests

After you have written code to Solve an Issue, you should create a pull request which will tell me that your code is ready to be merged with the main repository. I will then review your code and make some suggested changes. You will update your pull request and we will repeat the code review process until it is sparkly clean and ready to be added to the repository.

I will not discuss the mechanics of creating and updating a pull request using GitHub here. You should find the resources on your own. If you find anything particularly helpful, or you'd like to write up instructions yourself to include here, let me know.

Creating a Good Pull Request

When you create the pull request you should take care to only try merge code that fixes the specific issue you are targeting. Your request should:

Have a clear title that describes what you are adding/fixing. Something like UDP Sample Client and Server is fine.

Include a short description of the added code. This should also include a reference to the issue you are solving. Something like: Simple client and server using UDP sockets. Solves issue #1. Requires PThreads library to build.

Only include code changes that are relevant to the issue being solved. Learn how to revert unnecessary changes or create a branch in your repo that only includes the files you want me to pull and use that for the base of your pull request.

Carefully follow the CloudLab Style Guide. Be sure you pay attention to variable/function naming and indentation requirements.

Back and Forth

With very very high probability, I will ask you to make some changes to your code before I pull it into the repository. You should make the changes and update your pull request. After going back and forth a few times your code will be ready and I will pull it into the repository. Congrats!