Google Code-in

ns-3 recently switched its versioning control system from mercurial to git. While git is “easy enough” for most users, there is still the need for a clear set of instructions on how to properly submit a patch for evaluation, especially considering that from when a contributor starts proposing a patch to when it will be merged, the code might change.

The ns-3 manual contains two sections:

1. Working with git as a user
2. Working with git as a maintainer

However, this information should be also included in the tutorial.

The student is expected to write a concise How-To covering the following points:

1. Fork ns-3
2. Create a branch
3. Work on the branch
4. Submit a merge request to ns-3
5. Keep the branch updated to the latest ns-3 development point
6. Remove the branch (when the patch has been approved and merged)

The new section should clearly divide the workflow into these separate use-cases:

1. A user who wants to keep ns-3 up-to-date, and its own scripts on git.
2. A user who wants to submit a patch to ns-3
3. A user who wants to submit a new module to ns-3