Home

Welcome to the NetCreate wiki!

Currently we have:

• Installation Guide is work-in-progress "how to install and run the project".
• Decision Log describes, at a high level, the reasons behind our technical decisions because this is interesting stuff to share with other generalist programmers who are learning Javascript web app development.

Branch Management Notes

In general, the dev branch should always be a relatively stable running version good enough for QA. Any bleeding edge features are added in separate branches off of dev and merged back in when they are stable.

The master branch should be production-ready, but will usually not have the latest features. In general, this is what should be deployed in the classroom, though sometimes hotfixes might end up in the dev branch. Stable versions will be tagged with a version number, e.g. 1.0.1.

IU tweaks should be made in the iu-tweak branch. Feature development is handled in a similar manner. In this way the main dev branch should always be operational. Ben or Dave will be responsible for reviewing and merging the iu-tweaks back into the main dev branch.

In brief, this is how it should work:

1. Checkout the iu-tweak branch.
2. Merge the current dev branch into iu-tweak. (this won't be necessary if iu-tweak is already up-to-date with dev).
3. MAKE YOUR CHANGES
4. Commit your changes to the iu-tweak branch, labeling your commit message with your initials, e.g. kc: Remove 'id' field from Edge Table
5. Push your changed iu-tweak branch back up to GitHub, which makes your changes visible to everyone.
6. Ben or Dave can then review your changes and merge into dev.

Here is a more detailed version with some Git background theory and a video.