License cleanup / Effort Estimation changes

A license cleanup was done: * started to add the long and not really neccesary license header to each file which changed. * Removed files which unknown license / copyright information Effort estimation validation check execution is now configurable. Signed-off-by: Andreas Florath <[email protected]>
florath · Jul 3, 2020 · 6e7def6 · 6e7def6
1 parent ebf7c07
commit 6e7def6
Show file tree

Hide file tree

Showing 11 changed files with 244 additions and 8 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -0,0 +1,38 @@
+..
+  (c) 2020 by flonatel GmbH & Co. KG
+  
+  SPDX-License-Identifier: GPL-3.0-or-later
+
+  This file is part of rmtoo.
+
+  rmtoo is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  rmtoo is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.
+
+
+How to Contribute
+=================
+
+We'd love to accept your patches and contributions to this
+project. There are just a few small guidelines you need to follow.
+
+Contributor License Agreement
+=============================
+
+When you actively push changes to one of our development platforms,
+e.g. using a pull or merge request, you agree that your contribution
+is placed under GPL3 for the complete project - except the contents of
+the contrib/template_project folder which is placed under Apache 2
+license.
+
+New files must include an appropriate license header - including the
+SPDX license identifier.
diff --git a/Readme.rst b/Readme.rst
@@ -1,3 +1,24 @@
+..
+  (c) 2010-2012,2017,2020 by flonatel GmbH & Co. KG / Andreas Florath
+  
+  SPDX-License-Identifier: GPL-3.0-or-later
+
+  This file is part of rmtoo.
+
+  rmtoo is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  rmtoo is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.
+
+
 rmToo
 +++++
 

diff --git a/contrib/license-header.txt b/contrib/license-header.txt
@@ -0,0 +1,18 @@
+ (c) 2020 by flonatel GmbH & Co. KG / Andreas Florath
+
+ SPDX-License-Identifier: GPL-3.0-or-later
+
+ This file is part of rmtoo.
+
+ rmtoo is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ rmtoo is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.
diff --git a/doc/release_notes/25.rst b/doc/release_notes/25.rst
@@ -0,0 +1,30 @@
+..
+  (c) 2020 by flonatel GmbH & Co. KG
+  
+  SPDX-License-Identifier: GPL-3.0-or-later
+
+  This file is part of rmtoo.
+
+  rmtoo is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  rmtoo is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.
+
+25.0.0
+======
+
+User visible changes
+--------------------
+
+* Drop support for python 2 - which is EOL
+* Effort estimation: introduce flag to allow any value
+  for the effort estimation.
+
diff --git a/doc/requirements/EftAllMeasures.req b/doc/requirements/EftAllMeasures.req
@@ -0,0 +1,31 @@
+# (c) 2020 by flonatel GmbH & Co. KG / Andreas Florath
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of rmtoo.
+#
+# rmtoo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rmtoo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.
+
+Name: Effort Estimation All Units
+Type: design decision
+Invented on: 2020-07-03
+Invented by: flonatel
+Description: The effort estimation \textbf{must} be an arbritary integer
+ number.
+Rationale: At some point the fibonacci numbers are not fine grainted
+ enogh.
+Owner: development
+Status: finished
+Class: implementable
+Topic: ReqTagEffortDesc
diff --git a/doc/requirements/EftAllowedMeasure.req b/doc/requirements/EftAllowedMeasure.req
@@ -1,11 +1,30 @@
+# (c) 2020 by flonatel GmbH & Co. KG / Andreas Florath
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of rmtoo.
+#
+# rmtoo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rmtoo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.
+
 Name: Effort Estimation Allowed Measure Unit
 Type: design decision
 Invented on: 2010-03-06
 Invented by: flonatel
 Description: The effort estimation \textbf{must} be one of {0, 1, 2,
- 3, 5, 8, 13, 21}.
+ 3, 5, 8, 13, 21, 34}.
 Rationale: This is the typically used start of the fibonacci numbers
- for this.  0 is no effort, 1 is tiny effort and so on until 21 is
+ for this.  0 is no effort, 1 is tiny effort and so on until 34 is
  huge effort.
 Owner: development
 Status: finished

diff --git a/doc/requirements/EftMeasure.req b/doc/requirements/EftMeasure.req
@@ -1,3 +1,22 @@
+# (c) 2020 by flonatel GmbH & Co. KG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of rmtoo.
+#
+# rmtoo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rmtoo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.
+
 Name: Effort Estimation Measure
 Type: design decision
 Invented on: 2010-03-06
@@ -11,5 +30,5 @@ Owner: development
 Status: finished
 Class: implementable
 Topic: ReqTagEffortDesc
-Solved by: EftAllowedMeasure
+Solved by: EftAllowedMeasure EftAllMeasures EftMeasuresConf
 # Added by rmtoo-normalize-dependencies
diff --git a/doc/requirements/EftMeasuresConf.req b/doc/requirements/EftMeasuresConf.req
@@ -0,0 +1,30 @@
+# (c) 2020 by flonatel GmbH & Co. KG / Andreas Florath
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of rmtoo.
+#
+# rmtoo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rmtoo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.
+
+Name: Effort Estimation Unit Configuration
+Type: design decision
+Invented on: 2020-07-03
+Invented by: flonatel
+Description: The effort estimation \textbf{must} be configuable that
+ different checks can be used
+Rationale: This can / should be done on on project level.
+Owner: development
+Status: finished
+Class: implementable
+Topic: ReqTagEffortDesc
diff --git a/rmtoo/inputs/ReqEffortEst.py b/rmtoo/inputs/ReqEffortEst.py
@@ -6,7 +6,22 @@
 
  (c) 2010-2012,2017,2020 by flonatel GmbH & Co. KG
 
- For licensing details see COPYING
+ SPDX-License-Identifier: GPL-3.0-or-later
+
+ This file is part of rmtoo.
+
+ rmtoo is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ rmtoo is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with rmtoo.  If not, see <https://www.gnu.org/licenses/>.
 '''
 
 #

diff --git a/share/man/man5/rmtoo-config4.5 b/share/man/man5/rmtoo-config4.5
@@ -16,7 +16,7 @@
 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 .\" GNU General Public License for more details.
 .\"
-.\" (c) 2010-2012 by flonatel ([email protected])
+.\" (c) 2010-2012,2020 by flonatel ([email protected])
 .\"
 .TH rmtoo-config 5 2017-04-25 "User Commands" "Requirements Management"
 .SH NAME
@@ -219,6 +219,10 @@ This must be a list of strings specifying the stakeholders.
 Stakeholders can own a and prioritize a requirement.  Tags:
 \fIOwner\fR and \fIPriority\fR.
 
+.SS effort_estimation_values_check
+A boolean which flags if the effort estimation check is performed.
+Default: \fItrue\fR
+
 .SH TOPICS DETAILS
 Each topic contains configuration is a map as a value which the name
 of the topic set as the key.
@@ -344,5 +348,5 @@ for the same topic set in only one rmtoo call.
 .SH AUTHOR
 Written by Andreas Florath ([email protected])
 .SH COPYRIGHT
-Copyright \(co 2010-2017 by flonatel ([email protected]).
+Copyright \(co 2010-2017,2020 by flonatel ([email protected]).
 License GPLv3+: GNU GPL version 3 or later
diff --git a/share/man/man5/rmtoo-req-format.5 b/share/man/man5/rmtoo-req-format.5
@@ -16,7 +16,7 @@
 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 .\" GNU General Public License for more details.
 .\"
-.\" (c) 2010-2012 by flonatel ([email protected])
+.\" (c) 2010-2012,2020 by flonatel ([email protected])
 .\"
 .TH rmtoo-req-format 5 2012-03-23 "File Formats" "Requirements Management"
 .SH NAME
@@ -126,6 +126,17 @@ burn-down speed and the expected finished date.
 .P
 .B 21
 - huge effort (same as very big effort and big effort)
+.P
+.B 34
+- imense effort (mostly too big to do in one step)
+.P
+If this way of providing effort does not fit to the project,
+the check / enforcing can be switched off by setting the configuration
+parameter
+.B
+requirements.effort_estimation_values_check
+.P
+to false.
 .SH KEY 'Constraints'
 This must be a list of constraints - including possible
 arguments. Please consult the
@@ -167,6 +178,6 @@ is the one which should be used in new projects.
 .SH AUTHOR
 Written by Andreas Florath ([email protected])
 .SH COPYRIGHT
-Copyright \(co 2010-2011 by flonatel ([email protected]).
+Copyright \(co 2010-2011,2020 by flonatel ([email protected]).
 License GPLv3+: GNU GPL version 3 or later