openstack/deb-designate
Code Issues Proposed changes
0a983719b6
deb-designate/doc/source/developer-guidelines.rst
Kiall Mac Innes 1aaa0265f2 Add Developer Guidelines docs page 
Initially, this page contains guidance on the use of example
domain names and IP space throughout our codebase.

Change-Id: Id8b9aa6d924a43dbeedc5b9f3b858a4ff464fdf5
2015-03-01 15:21:20 +00:00

1.6 KiB
Raw Blame History

Developer Guidelines

Example DNS Names and IP Space

The IANA has allocated several special purpose domains and IP blocks for use as examples in code and documentation. Where possible, these domains and IP blocks should be preferred. There are some cases where it will not be possible to follow this guidance, for example, there is currently no reserved IDN domain name.

We prefer to use these names and IP blocks to avoid causing any unexpected collateral damage to the rightful owners of the non-reserved names and IP space. For example, publishing an email address in our codebase will more than likely be picked up by spammers, while published URLs etc using non-reserved names or IP space will likely trigger search indexers etc to begin crawling.

Reserved Domains

Reserverd DNS domains are documented here: IANA Special Use Domain Names.

Several common reserved domains:

  • example.com.
  • example.net.
  • example.org.

Reserved IP Space

Reserverd IP space is documented here: IANA IPv4 Special Registry, and IANA IPv6 Special Registry.

Several common reserved IP blocks:

  • 192.0.2.0/24
  • 198.51.100.0/24
  • 203.0.113.0/24
  • 2001:db8::/32