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.

• Introduction
• General
  • Licensing
  • Copyright
  • Attribution
  • Coding style
  • Creating a patch
  • Maintainers
• Submitting enhancements
  • GitLab.com trackers
  • Reporting issues
  • Submitting merge requests
  • Feature requests
• Submitting new models
  • Options for new models
  • Upstreaming new models
  • Code reviews
  • Submission structure
  • Documentation, tests, and examples
• Submitting externally maintained code
  • Rationale for the app store
  • App types
  • Submitting to the app store
  • Code review for apps
  • Maintaining app store modules
  • Links to related projects
  • Unmaintained, contributed code
• Coding style
  • Clang-format
  • check-style-clang-format.py
  • Clang-tidy
  • Source code formatting