Contributing to ns-3

This is the ns-3 Contributing Guide. Primary documentation for the ns-3 project is organized as follows:

• Several guides that are version controlled for each release (the latest release) and development tree:

  • Tutorial

  • Installation Guide

  • Manual

  • Model Library

  • Contributing Guide (this document)

• ns-3 Doxygen: Documentation of the public APIs of the simulator

• ns-3 wiki

This document is written in reStructuredText for Sphinx and is maintained in the doc/contributing directory of ns-3’s source code. Source file column width is 100 columns.

• 1. Introduction
• 2. General
  • 2.1. Licensing
  • 2.2. Copyright
  • 2.3. Attribution
  • 2.4. Coding style
  • 2.5. Creating a patch
  • 2.6. Maintainers
• 3. Submitting enhancements
  • 3.1. GitLab.com trackers
  • 3.2. Reporting issues
  • 3.3. Submitting merge requests
  • 3.4. Feature requests
• 4. Submitting new models
  • 4.1. Options for new models
  • 4.2. Upstreaming new models
  • 4.3. Code reviews
  • 4.4. Submission structure
  • 4.5. Documentation, tests, and examples
  • 4.6. Module dependencies
• 5. Submitting externally maintained code
  • 5.1. Rationale for the app store
  • 5.2. App types
  • 5.3. Submitting to the app store
  • 5.4. Licensing for app store modules
  • 5.5. Code review for apps
  • 5.6. Maintaining app store modules
  • 5.7. Links to related projects
  • 5.8. Unmaintained, contributed code
• 6. Coding style
  • 6.1. Clang-format
  • 6.2. check-style-clang-format.py
  • 6.3. Clang-tidy
  • 6.4. Source code formatting
  • 6.5. CMake file formatting
  • 6.6. Python file formatting
  • 6.7. Markdown Lint
• 7. Best practices
  • 7.1. Development phase