Skip to content

Commit d8c00a5

Browse files
lsawadelsawade
committed
Merge branch 'main' into devel
2 parents 2d783b7 + 0bb466c commit d8c00a5

File tree

5 files changed

+55
-13
lines changed

5 files changed

+55
-13
lines changed

‎README.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ SPECFEM++ is a complete re-write of SPECFEM suite of packages (SPECFEM2D, SPECFE
2828
## Documentation
2929

3030

31-
The online documentation for SPECFEM++ is located [here](https://specfem2d-kokkos.readthedocs.io/en/latest/index.html#)
31+
The online documentation for SPECFEM++ is located
32+
[here](https://specfem2d-kokkos.readthedocs.io/en/latest/index.html#)
3233

3334
## Getting Started with SPECFEM++
3435

@@ -40,9 +41,15 @@ We recommend starting with the [cookbook examples](https://specfem2d-kokkos.read
4041

4142
## Contributing to SPECFEM++
4243

43-
SPECFEM is a community project that lives by the participation of its members — i.e., including you! It is our goal to build an inclusive and participatory community so we are happy that you are interested in participating! Please see [this page](https://specfem2d-kokkos.readthedocs.io/en/latest/developer_documentation/index.html) for developer documentation.
44+
SPECFEM is a community project that lives by the participation of its members —
45+
i.e., including you! It is our goal to build an inclusive and participatory
46+
community so we are happy that you are interested in participating! Please see
47+
[this
48+
page](https://specfem2d-kokkos.readthedocs.io/en/latest/sections/developer_documentation/contributing.html)
49+
for developer documentation.
4450

45-
In particular you should follow the git development workflow and pre-commit style checks when contributing to SPECEFM.
51+
In particular you should follow the git development workflow and pre-commit
52+
style checks when contributing to SPECFEM++.
4653

4754
## License
4855

‎docs/index.rst‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,6 @@
55
SPECFEM++ - A modular and portable spectral-element code for seismic wave propagation
66
=====================================================================================
77

8-
.. image:: https://jenkins.princeton.edu/buildStatus/icon?job=SpecFEM_KOKKOS%2FGNU+Compiler&build=last&subject=GCC%20Build
9-
:alt: GCC Build
10-
11-
.. image:: https://jenkins.princeton.edu/buildStatus/icon?job=SpecFEM_KOKKOS%2FIntel_Compiler_Checks&build=last&subject=IntelLLVM%20Build
12-
:alt: IntelLLVM Build
13-
14-
.. image:: https://jenkins.princeton.edu/buildStatus/icon?job=SpecFEM_KOKKOS%2FNVIDIA_Compiler_Checks&build=last&subject=NVIDIA%20Build
15-
:alt: NVIDIA Build
16-
178
.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
189
:target: https://github.com/PrincetonUniversity/SPECFEMPP/blob/main/LICENSE
1910
:alt: License
@@ -277,6 +268,7 @@ Contribution
277268
:maxdepth: 1
278269
:hidden:
279270

271+
sections/developer_documentation/contributing
280272
sections/developer_documentation/style
281273
sections/developer_documentation/git_workflow
282274
sections/developer_documentation/build_requirements

‎docs/sections/developer_documentation/build_requirements.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Build system requirements
22
==========================
33

4-
This section covers compilation checks required so that SPECFEM++ is able to run across all architectures.
4+
This section covers compilation checks required so that SPECFEM++ is able to run
5+
across all architectures.
56

67
.. note::
78

‎docs/sections/developer_documentation/contributing.rst‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. _contributing:
2+
3+
Contributing to SPECFEM++
4+
=========================
5+
6+
7+
The easiest way to contribute is by starting to `fork the repository
8+
<https://github.com/PrincetonUniversity/SPECFEMPP/fork>`_, make and commit
9+
changes, and `create a pull request
10+
<https://github.com/PrincetonUniversity/SPECFEMPP/compare>`_ from your updated
11+
fork to the ``devel`` branch of the `SPECFEM++ repository
12+
<https://github.com/PrincetonUniversity/SPECFEMPP>`_.
13+
14+
15+
That being said, we do have some basic guidelines for contributing.
16+
17+
Style guidelines
18+
----------------
19+
20+
To ensure that the code is consistent and follows best practices, the code style
21+
is *automatically* enforced using pre-commit hooks, which are configured in the
22+
`.pre-commit-config.yaml` file in the root of the repository. More about this in
23+
the :ref:`style` documentation.
24+
25+
26+
Github Issues and pull requests handling
27+
----------------------------------------
28+
29+
This includes guidelines for managing GitHub issues and pull requests, which is
30+
described in the :ref:`git-workflow` documentation, which goes over the
31+
branching model and the process for making contributions.
32+
33+
34+
*For maintainers*: Continuous integration (CI)
35+
----------------------------------------------
36+
37+
This includes guidelines for the continuous integration (CI) process, which is
38+
described in the :ref:`tests` documentation. The CI process ensures that the
39+
code is tested and validated before it is merged into the ``main`` or ``devel``
40+
branches.

‎docs/sections/developer_documentation/git_workflow.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _git-workflow:
2+
13
Git development workflow
24
========================
35

0 commit comments

Comments
 (0)