From c9fb2dd0d85886dfe69179f59ae1f3590eddbc73 Mon Sep 17 00:00:00 2001 From: Tom Vo Date: Wed, 31 Jan 2024 14:58:01 -0800 Subject: [PATCH] Update titles --- CONTRIBUTING.rst | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e061a159..f58a8415 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -36,7 +36,7 @@ return here to get your development environment setup. **New contributions must be made under the Apache-2.0 with LLVM exception license.** -Documentation Updates +Documentation updates ~~~~~~~~~~~~~~~~~~~~~ Contributing to the `documentation`_ is an excellent way to help xCDAT. Anything from @@ -103,8 +103,6 @@ you can work seamlessly between your local repository and GitHub. but contributors who are new to git may find it easier to use other tools instead such as `GitHub Desktop`_. -.. Links - .. _GitHub has instructions for setting up Git: https://help.github.com/set-up-git-redirect .. _templates: https://github.com/xCDAT/xcdat/issues/new/choose .. _documentation: https://xcdat.readthedocs.io/en/latest/ @@ -217,7 +215,7 @@ Contributing to the code base .. contents:: :local: -Pull Request (PR) +Pull request (PR) ~~~~~~~~~~~~~~~~~ When you open a `pull request`_ on GitHub, there a template with a checklist available to use. @@ -240,7 +238,7 @@ Here's a simple checklist for PRs: .. _code-formatting: -Code Formatting +Code formatting ~~~~~~~~~~~~~~~ xCDAT uses several tools to ensure a consistent code format throughout the project: @@ -267,7 +265,7 @@ hooks` section above for instructions. .. _mypy: http://mypy-lang.org/ .. _type hints: https://docs.python.org/3/library/typing.html -Testing With Continuous Integration +Testing with continuous integration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The xCDAT `build workflow`_ runs the test suite automatically via the `GitHub Actions`_, @@ -307,10 +305,10 @@ the expected correct result:: assert_identical(expected, actual) -Developer Tips +Developer tips -------------- -Helpful Commands +Helpful commands ~~~~~~~~~~~~~~~~ .. note::