Tomh: /* Objective */

2023-03-27T17:35:29Z

Objective

← Older revision		Revision as of 17:35, 27 March 2023
Line 31:		Line 31:
	=== Objective ===		=== Objective ===

	~~To be completed~~.		Provide a fix for [https://gitlab.com/nsnam/ns-3-dev/-/issues/263 Issue 263].

	=== What to submit ===		=== What to submit ===

Tomh: start patch requirement page

2023-03-27T15:26:41Z

start patch requirement page

New page

{{TOC}}

As part of their Google Summer of Code 2023 applications to ns-3, we require that applicants produce at least a small amount of code for ns-3. This will allow us to gauge your ability to dive into source code, understand it, make a modification, and proceed to build and verify if your modification works.

Applicants who have already contributed a patch to ns-3 should check with the org admins whether the patch requirement can be satisfied by this prior code. If you have code posted somewhere else (GitHub, for example, or a class project page) that you feel is a good indicator of your ability to write ns-3 code, please point us to the URL.

For everyone else, there are two choices:

# Try to fix one of our [https://gitlab.com/nsnam/ns-3-dev/issues open technical issues] by submitting a merge request [https://www.nsnam.org/docs/contributing/html/enhancements.html#submitting-merge-requests in the usual way].
#* '''Note:''' if there is already a fix pending for a given issue, one cannot duplicate the effort and submit a second request.
# Complete the minimum patch requirement project below, and submit the patch not as a merge request (where others can see it) but privately as a diff or patchfile, or [https://docs.gitlab.com/ee/user/snippets.html GitLab.com snippet]). You can email a patch to one of the org admins if you prefer.

== Patch requirement ==

=== Setting up the environment ===

Perform the following steps (you may want to review our [https://www.nsnam.org/docs/installation/html/index.html Installation guide]).

* Download the ns-3-dev repository, or fork it or clone it from Git:

$: git clone https://gitlab.com/nsnam/ns-3-dev.git
$: cd ns-3-dev
$: git checkout -b patch-requirement origin/master

* Verify if you can build ns-3 and run the test suite:

$: ./ns3 configure --enable-examples --enable-tests
$: ./ns3 build
$: ./test.py

=== Objective ===

To be completed.

=== What to submit ===

A patch to ns-3-dev that accomplishes the objectives. In your GSoC application, point us to a publicly available URL where you've hosted the patch (such as a "gist" on github.com, or a snippet on gitlab.com, for instance). You can also send a [https://opensource.com/article/18/8/diffs-patches patch] to one of the org admins. If you need help with this step, contact one of the org admins for advice.

'''Note:''' Keep your solution private by pasting the link in your application PDF to Google, or sending a patch to an org admin, not posting it on the mailing list.

'''Note:''' You can share your patch with a GSoC mentor prior to the deadline, for initial feedback, if you have any doubt about it.

GSOC2023PatchRequirement - Revision history

Tomh: /* Objective */

Tomh: start patch requirement page