Skip to content

Commit 93aaa4c

Browse files
Merge pull request #46 from delphidabbler/readme-sourcecode-update
Update README.md
2 parents 5704850 + 81e6df5 commit 93aaa4c

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,15 @@ There's also plenty of info available on how to compile CodeSnip from source - s
4343

4444
CodeSnip's source code is maintained in the [`delphidabbler/codesnip`](https://github.com/delphidabbler/codesnip) Git repository on GitHub†.
4545

46-
[Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology has been adopted, with the exception of some branches that have been used in various attempts to start work on CodeSnip 5.
46+
The [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology has been adopted, with the exception of some branches that have been used in various attempts to start work on CodeSnip 5.
4747

48-
The following branches existed at the time when CodeSnip v4.16.0 was released:
48+
The following branches existed as of 2022/01/01:
4949

5050
* `master`: Always reflects the state of the source code as of the latest release.‡
51-
* `develop`: Main development branch. The head of this branch contains the latest development code.
51+
* `develop`: Main development branch. The head of this branch contains the latest v4 development code.
52+
* `belvedere`: The latest attempt to develop CodeSnip 5. See the [Belvedere Readme file](https://github.com/delphidabbler/codesnip/blob/belvedere/README.md) for a full explanation.
5253
* `pagoda`: An abortive attempt at developing CodeSnip 5. Work on this branch has halted. It does not follow GitFlow methodology. ***Do not use this branch: it may be pruned.***
53-
* `pavilion`: Another attempt at working on CodeSnip 5. It branched off `pagoda` and it's future is uncertain. Again it does not follow GitFlow methodology.
54+
* `pavilion`: Another attempt at working on CodeSnip 5. It branched off `pagoda` and work on it has halted. Again it does not follow GitFlow methodology. ***Do not use this branch: it may be pruned.***
5455

5556
New features and most bug fixes are worked on in `feature/xxxx` branches that are branched off `develop` locally. They are merged into `develop` as they are completed and the branches are deleted.
5657

@@ -62,7 +63,17 @@ Note that the default branch on GitHub is `master`, which contains the state of
6263
6364
### Contributions
6465

65-
To contribute to the project please fork the repository on GitHub. Create a feature branch off the `develop` branch. Make your changes to the feature branch then submit a pull request via GitHub.
66+
#### CodeSnip 4
67+
68+
To contribute to CodeSnip 4 development please fork the repository on GitHub. Create a feature branch off the `develop` branch. Make your changes to your feature branch then submit a pull request via GitHub.
69+
70+
> **Do not create branches off `master`, always branch from `develop`.**
71+
72+
#### CodeSnip 5 Belvedere
73+
74+
Proceed as for CodeSnip 4 except create your feature branch off the `belvedere` branch instead of `develop`.
75+
76+
> **Do not submit changes to the earlier `pagoda` or `pavilion` branches because they will not be accepted.**
6677
6778
### Compiling
6879

0 commit comments

Comments
 (0)