Noblis / INVSC-janus

IARPA Janus Program API
Other
9 stars 16 forks source link

Reorganization of branches #23

Closed JordanCheney closed 8 years ago

JordanCheney commented 9 years ago

Hello all,

There has been some confusion recently about which branch of this API Janus performers should be conforming to. To alleviate that confusion I am proposing a new organization for the branches here on Github and also for the documentation at libjanus.org.

The reorganization will be as follows. The master branch will become the stable branch that everyone should be compatible with. A new branch (will be called phase 2 at the moment) will contain API changes and updates planned for the next phase of the program. When the program moves into the next phase that branch will be merged into master and a new branch will be made to accept new changes for the following phase of the program. Only critical bug fixes will ever be merged into master once it is declared stable. We will also maintain an archive of the previous versions of the API under appropriately labelled branches.

The documentation at libjanus.org will be automatically generated using doxygen from the master branch here. At some point in the future we would like to add functionality to the page that allows you to select which branch's documentation you would like to view (and indicates which branch you are currently viewing). Until you see that please assume the documentation is for the master branch only!

I am planning on making these changes next Wednesday (Nov 4) unless there are issues. If you do have issues please respond in this thread so that we can all discuss them.

-Jordan

JordanCheney commented 8 years ago

This is finally committed and now reflected in the branch structure