mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-28 14:15:42 -04:00
Implement policy for Python, C++, and CMake versions (#3035)
This commit is contained in:
parent
8be35cd7b5
commit
89d4dafa5a
10 changed files with 44 additions and 29 deletions
|
|
@ -15,6 +15,7 @@ other related topics.
|
|||
contributing
|
||||
workflow
|
||||
styleguide
|
||||
policies
|
||||
tests
|
||||
user-input
|
||||
docbuild
|
||||
|
|
|
|||
35
docs/source/devguide/policies.rst
Normal file
35
docs/source/devguide/policies.rst
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
.. _devguide_policies:
|
||||
|
||||
========
|
||||
Policies
|
||||
========
|
||||
|
||||
---------------------
|
||||
Python Version Policy
|
||||
---------------------
|
||||
|
||||
OpenMC follows the Scientific Python Ecosystem Coordination guidelines `SPEC 0
|
||||
<https://scientific-python.org/specs/spec-0000/>`_ on minimum supported
|
||||
versions, which recommends that support for Python versions be dropped 3 years
|
||||
after their initial release.
|
||||
|
||||
-------------------
|
||||
C++ Standard Policy
|
||||
-------------------
|
||||
|
||||
C++ code in OpenMC must conform to the most recent C++ standard that is fully
|
||||
supported in the `version of the gcc compiler
|
||||
<https://gcc.gnu.org/projects/cxx-status.html>`_ that is distributed with the
|
||||
oldest version of Ubuntu that is still within its `standard support period
|
||||
<https://ubuntu.com/about/release-cycle>`_. Ubuntu 20.04 LTS will be supported
|
||||
through April 2025 and is distributed with gcc 9.3.0, which fully supports the
|
||||
C++17 standard.
|
||||
|
||||
--------------------
|
||||
CMake Version Policy
|
||||
--------------------
|
||||
|
||||
Similar to the C++ standard policy, the minimum supported version of CMake
|
||||
corresponds to whatever version is distributed with the oldest version of Ubuntu
|
||||
still within its standard support period. Ubuntu 20.04 LTS is distributed with
|
||||
CMake 3.16.
|
||||
|
|
@ -40,7 +40,7 @@ Follow the `C++ Core Guidelines`_ except when they conflict with another
|
|||
guideline listed here. For convenience, many important guidelines from that
|
||||
list are repeated here.
|
||||
|
||||
Conform to the C++14 standard.
|
||||
Conform to the C++17 standard.
|
||||
|
||||
Always use C++-style comments (``//``) as opposed to C-style (``/**/``). (It
|
||||
is more difficult to comment out a large section of code that uses C-style
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue