devel-ideal-proj.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Wed, 20 Jul 2011 10:51:44 +0300
changeset 897 b4d7d3091494
parent 738 969b166d66ce
child 899 7b4265c8d324
permissions -rw-r--r--
Move info abput proj siles into separate file.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
     1
-*- mode: outline; coding: utf-8; fill-column: 80 -*-
241
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
     3
* Ideal software development model.
271
594c6470789d Restricition of close source development.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 256
diff changeset
     4
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
     5
This file mainly discuss about open source software project.
271
594c6470789d Restricition of close source development.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 256
diff changeset
     6
594c6470789d Restricition of close source development.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 256
diff changeset
     7
* Open source.
594c6470789d Restricition of close source development.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 256
diff changeset
     8
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
     9
Open source software project have freedom how develop project and which
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    10
development toolchains use.
241
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    11
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    12
* Close source.
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    13
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    14
Close source projects have proprietary nature because of:
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    15
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    16
 * interest to make money (another parties can not easily reproduce project or
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    17
   steal realisation ideas/code, allowing another party get same product and get
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    18
   company money)
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    19
 * low code quality (to stop stain company good name or to stop malicious
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    20
   attacks based on code analysis)
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    21
 * security consideration (to hide protocols and data format to make harder
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    22
   malicious attack)
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    23
 * business model (closed data formats allow vendor lock)
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    24
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    25
Disadvantage of closed source project (in many case):
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    26
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    27
 * you can not directly contact with developers (only through support)
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    28
 * low support quality
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    29
 * paid support (and you have no enough money)
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    30
 * can not access to product bug tracing system (you only can submit bug via
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    31
   crash report application or technical support, publicly appear internal bug
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    32
   tracing can damage product reputation
271
594c6470789d Restricition of close source development.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 256
diff changeset
    33
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    34
* Component of software project.
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    35
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    36
 * Src (sources).
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    37
 * Doc (documentation).
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    38
 * VCS (version control system).
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    39
 * BTS (bug tracking).
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    40
 * News (project news/history/changelog).
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    41
897
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 738
diff changeset
    42
* Docs.
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    43
897
b4d7d3091494 Move info abput proj siles into separate file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 738
diff changeset
    44
TODO
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    45
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    46
* Project home page.
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    47
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    48
Project home page must provide:
256
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    49
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    50
 * project name
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    51
 * short info about project goal
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    52
 * project license
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    53
 * current project status
256
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    54
 * links to binary release
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    55
 * links to source release, how to get latest source from VCS
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    56
 * links to online/printed docs
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    57
 * how report bug (BUGS)
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    58
 * where send patch
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    59
 * contact info
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    60
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    61
Additionally:
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    62
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    63
 * help welcome, requirement to join to project
271
594c6470789d Restricition of close source development.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 256
diff changeset
    64
 * mail/news list for users/developers, how to subscribe/unsubscribe, where
594c6470789d Restricition of close source development.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 256
diff changeset
    65
   find archive, how search for keyword in archive
256
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    66
 * project history (NEWS, ChangeLog)
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    67
 * project policy (HACKING)
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    68
 * how build project (README, INSTALL)
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    69
 * list of contributor with contact info (MAINTAINERS, AUTHORS)
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    70
 * who use project
db3b0f1b218f Home page must provide.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 241
diff changeset
    71
736
9b962c4c86e3 Added description of essential project files. Reformated and checked old text.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 670
diff changeset
    72
* VCS.
241
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    73
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    74
TAGS: VCS, version control system, SCM, source code management, DVCS,
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    75
      distributed version control system.
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    76
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    77
 * CVS
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    78
 * SVN
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    79
 * Mercurial (hg)
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    80
 * git
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    81
 * bazaar
904fb45c2a20 Ideal software project management.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    82