-
Notifications
You must be signed in to change notification settings - Fork 0
Things to read first
Kees den Heijer edited this page Oct 17, 2018
·
3 revisions
The policy of the TUDelft-CITG repository is that all code should be open source eventually. When initially developing code, one may want to restrict the access to a repository to a dedicated team (e.g. preceding publication). This can be arranged by the repository administrators. However, it is advised that generic code is kept strictly separated from sensitive information/data needed to run the code. Such information/data should not be stored in the repository, or any of its branches, as the information might become available in this way when the repository's restrictions are lifted eventually.
Repository etiquette. When collaborating in a repository there are a few things that we agree upon as being good repository etiquette:
- The master branch should always contain workable code (ideally with one or more example applications in a notebook).
- When working together on the same repository it is good practice to use the 'four eyes' principle (ask a colleague to review your pull request).
- When working on a repository share your to do's, actions in progress, under review and finished in a project. This will help others to understand what you are doing.
- When you are new, experiment in separate repositories or branches, rather than 'disturbing' ongoing work of others. When you are unsure what to do, ask!