Mercurial Mercurial > tips / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
devel-proj-files.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Thu, 21 Jul 2011 18:00:59 +0300
changeset 909 42a2f77b2b90
parent 908 660c0dac57c2
child 910 c3fc5f36d101
permissions -rwxr-xr-x
README

.. contents::

Essential project files.
========================

 * README
 * INSTALL
 * 

General info files.
===================

README file.
------------

 * README file should refer to the file INSTALL and copying conditions.
 * Use README-xxx for specific topic.

ABOUT/OVERVIEW/SUMMARY file.
----------------------------

ABOUT-NLS file.
---------------

 * Notes on the Free Translation Project.

NOTES/NOTICE file.
------------------

FEATURES file.
--------------

FEEDBACK file.
--------------

PLATFORMS file.
---------------

 * Supported platforms and compilers.

PROBLEMS/KNOWNBUG/WARNINGS file.
--------------------------------
::

  PROBLEMS
  KNOWNBUG  KNOWN_BUGS  KNOWN-BUGS
  WARNINGS

FORK file.
----------

 * Why this project is fork of another project.

COMMANDS file.
--------------

 * brief list of commands for built-in language

PROGLIST file.
--------------

UPGRADE/UPGRADING/CONVERSION file.
----------------------------------

 * How upgrade to new version.

MIRRORS/WHERE file.
-------------------

 * Where get src/build, mirrors list.

SERVICE/SUPPORT file.
---------------------

 * about support services for software

Thanks files.
=============
::

  ACKNOWLEDGEMENTS

Contributors files.
===================

AUTHOR file.
------------
::

  authors
  AUTHOR
  AUTHORS

README file.
============

Assumed that users first read this file before start using project.

 * Project name.
 * Project goal.
 * Point to license statements.
 * Point to build instructions.
 * Point to documentations.

ABOUT file.
===========

 * About project.
 * In form of 'ABOUT-xxx' - about topic 'xxx'.

Build/install instruction.
==========================

INSTALL file.
-------------

 * List of supported platform.
 * Build dependencies/prerequisites.
 * Build/installation instructions.

BUILD file.
-----------

CUSTOMIZE file.
---------------

 * Customize the compilation.

License files.
==============

DISCLAIMER file.
----------------

PATENTS file.
-------------

TRADEMARK file.
---------------

COPYING/LICENSE/LEGAL file.
---------------------------

COPYING usually used for GNU GPL like license. Another license put in LICENSE
file.

If some component comes with different license put it into file with name like::

  LICENSE.libmy LICENSE.regex LICENSE.doc
  COPYING-DOCS  COPYING-GPL   COPYING-LGPL  COPYING-LIBS  COPYING-TEMPLATES
  COPYING.LESSER

COPYRIGHT file.
---------------
::

  copyright
  COPYRIGHT
  copyright-artwork
  copyright-notice

AFL file.
---------

Academic Free License.

  AFL-1.1
  AFL-1.2
  AFL-2.0
  AFL-2.1

 * http://www.opensource.org/licenses/afl-3.0.php
 * http://en.wikipedia.org/wiki/Academic_Free_License

Apache file.
------------
::

  Apache-1.0
  Apache-1.1
  Apache-2.0

PHP file.
---------
::

  PHP-3.0

MIT file.
---------
::

  MIT  LICENSE_MIT

BSD file.
---------
::

  BSD  LICENSE_BSD

GPL file.
---------
::

  GPL-2    GPL2
  GPL-2.0
  GPL-3.0  GPL3
  LICENSE-GPL

LGPL file.
----------
::

  LGPL-2   LGPL-2.0  LGPL-2.1  LGPL-3.0  LICENSE_LGPL
  COPYING.LESSER

Developer files.
================

HACKING/DEVELOPERS/PORTING file.
--------------------------------

 * Notes for developers.

CONTENTS file.
--------------

 * Description which file for which comes.

CONTRIBUTE file.
----------------

 * Guidelines to contribute to the project.

::

  CONTRIB
  CONTRIBS
  CONTRIBUTE
  Contributing
  HOW-TO-CONTRIBUTE

DEBUG/DEBUGGING file.
---------------------

 * How debug sources, useful macros/function/tips.

DESIGN/INTERNALS/PROTOCOL file.
-------------------------------

TESTS/CHECK_NOTES file.
-----------------------

 * How run/add tests, requirements to run.
 * How and when test passed by which platform/configuration.

BINDINGS file.
--------------

 * Known bindings of library to different langs/frameworks.

Coding style files.
-------------------
::

  C++STYLE
  CodeStyle

CODING file.
------------

 * project policy and recommendation on coding

CONVENTIONS file.
-----------------

Authors files.
==============

AUTHORS/MAINTAINERS file.
-------------------------
::

  AUTHOR  AUTHORS  MAINTAINERS

 * Usually regular contributors.
 * List of project members with contact info (email/phone/home page/address/etc).

CONTRIBUTORS/THANKS/CREDITS/ file.
----------------------------------

 * Irregular contributor list.
 * Usually casual/non-regular contributors.

ACKNOWLEDGEMENTS file.
----------------------

DEDICATION file.
----------------

Project changes files.
======================

Here goes news and descriptions of user visible changes:

 * Important project news.
 * New features.
 * Obsolescense/deprecation of UIs/APIs/protocols/formats.
 * Incompatibilities with previous version.

ChangeLog file.
---------------

 * Changes made to program source files.
 * Explains how earlier versions were different from the current version.
 * Each directory can have its own change log.
 * Useful for RCS/CVS. Don't needed with modern VCS (SVN, Git, Mercurial, Bazaar).

::

  changelog  Changelog  ChangeLog
  CHANGELOG
  ChangeLog-1996-1999   ChangeLog-2000
  ChangeLogOld

COMPAT/COMPLIANCE file.
-----------------------

 * Compatibility with previous versions.

NEWS/OLDNEWS/ONEWS file.
------------------------

 * User-visible changes.
 * In each new release, add items to the front of the file and identify the
   version they pertain to.
 * Don't discard old items.
 * NEWS file gets very long, move some of the older items into a file named
   ONEWS and put a note at the end referring the user to that file.

CHANGES/WHATSNEW file.
----------------------
::

  Changes  CHANGES  CHANGES-release
  RELEASE_NOTES  ReleaseNotes  RELEASENOTES  RELEASE-NOTES
  RELNOTES
  SHORTLOG
  WHATSNEW

ANNOUNCE file.
--------------

Todo files.
===========

 * list of wanted, roadmap

::
  BACKLOG
  CHECKLIST
  TODO
  PROJECTS

PROGRESS file.
==============

Version info files.
===================

VERSION/RELDATE/RELEASE-DATE file.
----------------------------------

ANNOUNCE file.
--------------
::

  ANNOUNCE
  ANNOUNCEMENT

HISTORY file.
=============

 * Project history in long perspective.

FUTURE file.
============


Documentation files.
====================

USAGE file.
-----------

Refcard files.
--------------
::

  cheatsheet
  refcard

FAQ files.
----------

 * List of frequency asked questions with answers.

TIPS/HINTS file.
----------------

HOWTO file.
-----------

Bug report instructions.
========================
::

  BUGFORM
  BUG-REPORTING
  BUG-REPORTS
  BUGS

BINDINGS file.
==============

Reference.
==========

  /usr/share/doc/common-licenses/*
                from Cygwin 'base-files' package, list of licence files

Unknown files.
==============
::

  AUDIT
  DETAILS
  FILE-FORMAT
  Fixes
  FIXES
  FORMAT
  MAIL
  NEEDED
  PGPKEYS
  PKG-INFO - http://www.python.org/dev/peps/pep-0241/ http://www.python.org/dev/peps/pep-0314/
  PLACES
  ROADMAP
  TRACING

Reference.
==========

 * GNU Coding Standards
 * Gnits Standards
tips