In a nutshell

Here are the recommended ways (tool-agnostic!) to contribute to this repo:

• use branches when making changes. These are required to initiate pull requsts
• always create a pull request to propose changes to the remote repository (GitHub), even if the assignee is yourself;

In a nutbasket

The toolbox we use:

• GitHub Desktop. See here for a quick video

• Archi .

  • Note: For Windows users, the most convenient Archi installation would be the portable ZIP (make sure you download the correct architecture, e.g. x64). The screenshot below shows proven to work versions of Archi (4.6.0).

  

• Atom. Very convenient for resolving merge conflicts. See here for a video.

How to contribute (procedures and guidelines)

Archi modeling

You will need to understand the concepts of a distributed version control system to know how to collaborate, in particular how branching works.

NOTE: Multiple contributors to an Archi model do not work on the same model at once. They work on local copies they have on their PC and, when one is ready, pushes (publishes) their local copy to the remote server (the GitHub repository). When pushing to the remote server to communicate their intent to the rest of the team, they do so by initiating a Pull Request. You initiate a Pull Request by creating a branch and requesting that branch to be merged with another (most likely the master branch)

See here procedures and guidelines for contributing to Archi models

For Review

• ReleaseCandidate Report.
• CommonSandbox Report.

General repository contributions

to come...