Difference between revisions of "Project template"

From ProgClub
Jump to: navigation, search
(Putting TODO category in correct place...)
(Notes for ProgClub administrators)
Line 84: Line 84:
 
If you're looking to set up a development environment for this project here's what you need to know:
 
If you're looking to set up a development environment for this project here's what you need to know:
  
=== Doing a release ===
+
== Notes for ProgClub administrators ==
  
 
To release a version of this project use the [https://svn.jj5.net/jjrepo/jj5-bin/trunk/bin/pcrepo-branch-release pcrepo-branch-release] script from the [https://www.jj5.net/sixsigma/JJ5-bin jj5-bin] project:
 
To release a version of this project use the [https://svn.jj5.net/jjrepo/jj5-bin/trunk/bin/pcrepo-branch-release pcrepo-branch-release] script from the [https://www.jj5.net/sixsigma/JJ5-bin jj5-bin] project:

Revision as of 06:48, 21 September 2016

{project name} is the ProgClub {project's purpose} software. That's the software that {does what the project does}. It's a fork of {whatever you've copied} with {whatever you've added}. For other projects see projects.

Status

Latest production version: unreleased. Latest development version: 0.1.1.

See tasks for work that still needs to be done.

Motivation

Why this software?

Administration

Contributors

Members who have contributed to this project. Newest on top.

All contributors have agreed to the terms of the Contributor License Agreement. This excludes any upstream contributors who tend to have different administrative frameworks.

Upstream contributors:

  • {link to project's upstream contributors, or delete this section}

Copyright

Copyright 2016, Contributors.

License

Licensed under the {New BSD, MIT, or GPL, or link to license file} license.

Components

Libraries, tools, services or media from third parties used under license:

  • List 'em

Resources

Downloads

TODO: link to downloads or explain why there aren't any.

Source code

The repository can be browsed online:

https://www.progclub.org/pcrepo/pcproject/branches/0.1

The latest stable released version of the code is available from:

https://www.progclub.org/svn/pcrepo/pcproject/tags/latest/0.1

Or if you want the latest version for development purposes:

https://www.progclub.org/svn/pcrepo/pcproject/branches/0.1

Links

Specifications

Functional specification

The functional specification describes what the project does.

Technical specification

The technical specification describes how the project works.

Notes

Notes for implementers

If you are interested in incorporating this software into your project, here's what you need to know:

Notes for developers

If you're looking to set up a development environment for this project here's what you need to know:

Notes for ProgClub administrators

To release a version of this project use the pcrepo-branch-release script from the jj5-bin project:

$ pcrepo-branch-release {project name} $MAJOR.$MINOR $REVISION

Where:

$MAJOR = the major version number, presently 0
$MINOR = the minor version number, presently 1
$REVISION = the revision number for this release

Note: the $REVISION number starts at 1 and is incremented for each release. The revision number is odd for development releases and even for production releases. See status for last production release and increment by two for next production release.

Tasks

TODO

Things to do, in rough order of priority:

  • Create the project in svn

Done

Stuff that's done. Latest stuff on top.

  • JE {yyyy-mm-dd}: created project page