1243
Comment: Formatting fix.
|
1891
Add sample HACKING.txt file.
|
Deletions are marked like this. | Additions are marked like this. |
Line 10: | Line 10: |
* Give the project a HACKING.txt file. The top of the HACKING.txt file should reference the generic (wiki-based) hacking guidelines, something like this: {{{ These are guidelines for hacking on the FOOBAR project. But first, please see the common hacking guidelines at: http://dev.launchpad.net/Hacking You should assume the above guidelines are in effect; below, we only discuss the ways (if any) in which the FOOBAR project differs from or extends those common guidelines. }}} Any further material in HACKING.txt should be specific guidelines about this project, not about projects in general. |
Release Checklist
Releasing a new package (whether part of Launchpad or not) involves many of the same steps each time. Barry knows more about them than almost anyone, so he's going to fill in this list :-).
First release only:
- Check for any proprietary licenses on dependencies. If any, stop at this step and go solve that problem first.
Add the appropriate open source license to the project (generally, AGPLv3 if it's server-side code, GPLv3 for anything else, but LGPLv3 if it needs to be useable in proprietary programs or there is a license incompatibility with the AGPLv3 or GPLv3.)
- Set up a Launchpad project for it.
Give the project a HACKING.txt file. The top of the HACKING.txt file should reference the generic (wiki-based) hacking guidelines, something like this:
These are guidelines for hacking on the FOOBAR project. But first, please see the common hacking guidelines at: http://dev.launchpad.net/Hacking You should assume the above guidelines are in effect; below, we only discuss the ways (if any) in which the FOOBAR project differs from or extends those common guidelines.
Any further material in HACKING.txt should be specific guidelines about this project, not about projects in general.- ...
- Move on to the "all releases" checklist below.
All releases (first and subsequent):
- Bump the version number.
- Update the NEWS file.
- Run $SOME_PYTHON_COMMAND to sign and upload.
- Make sure your GPG key is available.
- ...
- Ping Matt R or whoever's appropriate in Canonical, in case there are any special announcement needs for this release.
- Announce in appropriate places.