libstdc++-v3/docs/html/17_intro/contribute.html

   1 <html>
   2 <head>
   3 <title>How to contribute</title>
   4 </head>
   5 <!--990301 slightly modified version of the GCC contribute.html file-->
   6 <!-- #include virtual="/include/header-subpages.html"-->
   7 <body>
   8 <h2>How to contribute</h2>
   9 <p>
  10 The Standard C++ Library v3, or libstc++-2.90.x, follows an open development model. Active contributors are assigned maintainer-ship responsibility, and given write access to the CVS repository. First time submitors and all other potential contributors should follow this procedure:
  11 </p>
  12
  13 <hr />
  14 <h4>ONE : read the documentation</h4>
  15
  16 <ul>
  17  <li> Get and read the relevant sections of the C++ language
  18 specification. Copies of the full ISO 14882 standard are available on
  19 line via the ISO mirror site for committee members. Non-members, or
  20 those who have not paid for the privilege of sitting on the committee
  21 and sustained their two meeting commitment for voting rights, may get
  22 a copy of the standard from their respective national standards
  23 organization. In the USA, this national standards organization is ANSI
  24 and their web-site is right
  25
  26  <a href="http://www.ansi.org">here.</a>
  27 (And if you've already registered with them, clicking this link will take you to directly to the place where you can
  28 <a href="http://webstore.ansi.org/ansidocstore/product.asp?sku=ISO%2FIEC+14882%2D1998">buy the standard on-line.)</a>
  29 </li>
  30
  31 <li> The library working group bugs, and known defects, can be obtained at these web sites:
  32  <a href="http://www.dkuug.dk/jtc1/sc22/wg21/">http://www.dkuug.dk/jtc1/sc22/wg21 </a>
  33  and <a href="http://www.comeaucomputing.com/iso/">http://www.comeaucomputing.com/iso/</a>
  34 </li>
  35
  36 <li> The newsgroup dedicated to standardization issues is comp.std.c++: this FAQ for this group is quite useful and can be found <a href="http://reality.sgi.com/austern_mti/std-c++/faq.html"> here </a>.
  37 </li>
  38
  39  <li> Peruse the <a href="http://www.gnu.ai.mit.edu/prep/standards_toc.html">GNU Coding Standards</a>, and chuckle when you hit the part about "Using Languages Other Than C."
  40 </li>
  41
  42  <li> Be familiar with the extensions that preceded these general GNU rules. These style issues for libstdc++ can be found in the file C++STYLE, located in the root level of the distribution, or <a href="C++STYLE"> here. </a>
  43 </li>
  44
  45  <li> And last but certainly not least, read the library-specific information found <a href="../documentation.html"> here.</a>
  46 </li>
  47
  48 </ul>
  49
  50
  51
  52 <hr />
  53 <h4>TWO : copyright assignment</h4>
  54 <p>
  55 Small changes can be accepted without a copyright assignment form on
  56 file. New code and additions to the library need completed copyright
  57 assignment form on file at the FSF. Note: your employer may be required
  58 to fill out appropriate disclaimer forms as well. Here is the <a href="libstdc++-assign.txt"> form. </a>
  59
  60 Please contact <a href="mailto:benjamin@cygnus.com">Benjamin
  61 Kosnik</a> if you are confused about the assignment or have general
  62 licensing questions.
  63 </p>
  64
  65
  66 <hr />
  67 <h4>THREE : submitting patches</h4>
  68
  69 <p>
  70 Every patch must have several pieces of information before it can be
  71 properly evaluated. Ideally (and to ensure the fastest possible
  72 response from the maintainers) it would have all of these pieces:
  73 </p>
  74
  75 <ul>
  76
  77  <li> A description of the bug and how your patch fixes this bug. For
  78  new features a description of the feature and your implementation. </li>
  79
  80  <li> A ChangeLog entry as plaintext; see the various ChangeLog files
  81  for format and content. If using you are using emacs as your editor,
  82  simply position the insertion point at the beginning of your change
  83  and hit CX-4a to bring up the appropriate ChangeLog
  84  entry. See--magic! Similar functionality also exists for vi.  </li>
  85
  86  <li> A testsuite submission or sample program that will easily and
  87  simply show the existing error or test new functionality.  </li>
  88
  89  <li> The patch itself. If you are accessing the CVS repository at
  90  Cygnus, use "cvs update; cvs diff -c3p NEW"; else, use "diff -c3p OLD
  91  NEW" ... If your version of diff does not support these options, then
  92  get the latest version of GNU diff. </li>
  93
  94  <li> When you have all these pieces, bundle them up in a mail message
  95 and send it to libstdc++@gcc.gnu.org. All patches and related
  96 discussion should be sent to the libstdc++ mailinglist. </li>
  97
  98 </ul>
  99
 100 </body>
 101 </html>
 102