1.. ## Copyright (c) 2017-2021, Lawrence Livermore National Security, LLC and
2.. ## other Axom Project Developers. See the top-level LICENSE file for details.
3.. ##
4.. ## SPDX-License-Identifier: (BSD-3-Clause)
5
6.. _dirorgsec-label:
7
8=====================================
93 Directory Organization
10=====================================
11
12The goal of the guidelines in this section is to make it easy to locate a file
13easily and quickly. Make it easy for your fellow developers to find stuff they
14need.
15
16------------------------------------------
17Limit scope of directory contents
18------------------------------------------
19
203.1 The contents of each directory and file **must** be well-defined and
21limited so that the directory can be named to clearly indicate its contents.
22The goal is to prevent directories and files from becoming bloated with
23too many divergent concepts.
24
25
26----------------------------------------------------------
27Put files where it's easy to find them
28----------------------------------------------------------
29
303.2 Header files and associated implementation files **should** reside in
31the same directory unless there is a good reason to do otherwise. This is
32common practice for C++ libraries.
33
343.3 Each file **must** reside in the directory that corresponds to (and named
35for) the code functionality supported by the contents of the file.
36
37