diff --git a/.gitlab/merge_request_templates/request_for_changes.md b/.gitlab/merge_request_templates/request_for_changes.md index 354996678a5435ed27f162a2f9b0f2142004d211..0f49873998b82139ab80fa96fe710300cca68a67 100644 --- a/.gitlab/merge_request_templates/request_for_changes.md +++ b/.gitlab/merge_request_templates/request_for_changes.md @@ -22,8 +22,12 @@ Describe the testing strategy for new features. ### Documentation -List or link documentation modifications that were made (doxygen, example, software guide, application documentation, cookbook). +List or link documentation modifications that were made (doxygen, example, Software Guide, application documentation, CookBook). ### Additional notes -List remaining open issues if any, and additional notes. +List remaining open issues if any, and additional notes. + +### Copyright + +The copyright owner is *COPYRIGHT OWNER (OR OWNER'S AGENT)* and has signed the ORFEO ToolBox Contributor License Agreement diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 099b5cdec62900957a77d5afb59e5e7b2fcb6957..d5d8c34413d24cc601be42b630cd08f63021a0a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ There are many ways to contribute to OTB: * [Publishing a remote module](#remote-modules) Our main workflow uses GitLab for source control, issues and task tracking. We -use a self-hosted gitlab instance: +use a self-hosted GitLab instance: [`https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb`](https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb) @@ -69,7 +69,7 @@ develop without review must be avoided. On your feature branch, write a good [commit message](https://xkcd.com/1296/): short and descriptive. If fixing an issue or bug, put the issue number in the -commit message so that GitLab can [crosslink it](https://docs.gitlab.com/ce/user/project/issues/crosslinking_issues.html). +commit message so that GitLab can [cross-link it](https://docs.gitlab.com/ce/user/project/issues/crosslinking_issues.html). You can prefix your commit message with an indicating flag (DOC, BUG, PKG, TEST, SuperBuild, etc.). @@ -124,14 +124,34 @@ Again, the second branch name is optional. For users without push access to [otb-devutils repository](https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb-devutils.git), the modification can be asked through a merge requests to this repository. -Once the feature branch is registered for testing, it should appear in the *FeatureBranches* section of the [OTB dashboard](https://dash.orfeo-toolbox.org/index.php?project=OTB) next day (remember tests are run on a nighlty basis). +Once the feature branch is registered for testing, it should appear in the *FeatureBranches* section of the [OTB dashboard](https://dash.orfeo-toolbox.org/index.php?project=OTB) next day (remember tests are run on a nightly basis). Do not forget to remove the feature branch for testing once it has been merged. +### Contribution license agreement + +OTB requires that contributors sign out a [Contributor License +Agreement](https://en.wikipedia.org/wiki/Contributor_License_Agreement). The +purpose of this CLA is to ensure that the project has the necessary ownership or +grants of rights over all contributions to allow them to distribute under the +chosen license (Apache License Version 2.0) + +To accept your contribution, we need you to complete, sign and email to *cla [at] +orfeo-toolbox [dot] org* an [Individual Contributor Licensing +Agreement](https://www.orfeo-toolbox.org/cla/icla-en.doc) (ICLA) form and a +[Corporate Contributor Licensing +Agreement](https://www.orfeo-toolbox.org/cla/ccla-en.doc) (CCLA) form if you are +contributing on behalf of your company or another entity which retains copyright +for your contribution. + +The copyright owner (or owner's agent) must be mentioned in headers of all +modified source files and also added to the [NOTICE +file](https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb/raw/develop/NOTICE). + ## Remote modules [Remote Modules](https://wiki.orfeo-toolbox.org/index.php/Remote_Modules) are -the prefered way if you wish to make your apps and filters available to the +the preferred way if you wish to make your apps and filters available to the community while keeping control and maintenance of their sources. Remote modules are just like regular modules, except they are not distributed inside OTB source code. Under some conditions (dependencies, official acceptance @@ -139,13 +159,13 @@ process, etc.), we are also able to distribute your remote module in the official standalone binaries. See [the wiki](https://wiki.orfeo-toolbox.org/index.php/Remote_Modules) for more information. -## Gitlab guidelines +## GitLab guidelines -In order to organize the issues in our Gitlab instance, we use both labels and +In order to organize the issues in our GitLab instance, we use both labels and milestones. The [milestones](https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb/milestones) should be used to track in which release a feature is merged. -Gitlab can then provide a summary of all features and bugs added to a given release +GitLab can then provide a summary of all features and bugs added to a given release version. Regarding labels, we use the following set: