Skip to content
Snippets Groups Projects
Commit 0f8c2442 authored by Andrew Wilson's avatar Andrew Wilson :elephant:
Browse files

Add README and LICENSE

parents
No related merge requests found
/*=========================================================================
Program: Visualization Toolkit
Module: Copyright.txt
Copyright (c) 1993-2015 Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
of any contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/
What is this project ?
----------------------
This project is **NOT** the official VTK repository.
It is a fork of VTK sources hosted at https://gitlab.kitware.com/vtk/vtk.
It is used as staging area to maintain topics specific to VTK that will eventually be contributed back to the official repository.
What is the branch naming convention ?
--------------------------------------
Each branch is named following the pattern `imstk-vX.Y.Z-YYYY-MM-DD-SHA{N}`
where:
* `vX.Y.Z` is the version of VTK
* `YYYY-MM-DD` is the date of the last official commit associated with the branch.
* `SHA{N}` are the first N characters of the last official commit associated with the branch.
What is the title convention for commits ?
------------------------------------------
There are few scenarios to consider:
| Commit status | Title convention |
|--|--|
| already integrated upstream | Amend the commit title to include `[Backport] This is the original title`
| being considider for upstream integration | Amend the commit title to include `[Backport PR-<NNN>] This is the original title` where `<NNN>` identifies the associated pull request being reviewed. |
| applies only to iMSTK | If the commit will not be considered for upstream integration, consider using the prefix `[iMSTK] This is the title` |
Are there exceptions to the branch naming convention ?
------------------------------------------------------
- customRenderPipeline: Existed before conventions set forth. Contents need to be investigated to figure out if we can discard.
- multi-textures: Existed before conventions set forth. Contents need to be investigated to figure out if we can discard.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment