]> git.99rst.org Git - irssi-scripts.irssi.org.git/commitdiff
Updated the guidelines
authorGeert Hauwaerts <redacted>
Tue, 1 Jul 2014 19:55:05 +0000 (21:55 +0200)
committerGeert Hauwaerts <redacted>
Tue, 1 Jul 2014 19:55:05 +0000 (21:55 +0200)
Added a guideline for version numbering and ChangeLog updates.

README.markdown

index 51df1253d6617f04eeb5f3348e8599d9c71d676b..6501345d43c37dd86726ff8b716dced66cf51dc1 100644 (file)
@@ -14,6 +14,15 @@ To add or modify a script do the following:
 3. Add or modify your script in the repository. Remember to add it to Git using `git add`.
 4. If you are adding a new script, remember to add script information in `_data/scripts.yaml`. This file is sorted by script filename.
 5. If you are modifying a script, remember to increase the version number and update the last modification date.
+6. If the script has a ChangeLog, remember to include your modifications.
 6. Commit your changes to Git and push them to Github.
 7. Submit pull request.
 8. Await review of your changes by one of our developers.
+
+### Version Numbering
+
+To increase the version numbering, take the following conditions into account:
+
+1. Do not create explicit minor revision numbers if they are not present (1.3 becomes 1.4 or 2.1, not 1.3.1)
+2. When modifying an existing feature, increase the minor revision number (1.3 becomes 1.4, not 2.1)
+3. When adding a new feature, increase the major revision number (1.3 becomes 2.1, not 1.4)
git clone https://git.99rst.org/PROJECT