From f84b1c7312a6b332096eb71774c252ffbc3fb150 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Sun, 29 Oct 2023 12:35:33 -0400 Subject: [PATCH] docs: use relative links in markdown files (#1414) * convert URLs to relative links in markdown files * hyphens -> mdashes in CODE_OF_CONDUCT.md * remove unnecessary links in CONTRIBUTING.md --- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 8 +------- DEVELOPER.md | 2 +- 3 files changed, 3 insertions(+), 9 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 62f6ede8b94..d89a4670001 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,7 +1,7 @@ Code of Conduct =============== -All contributions to- and interactions surrounding- this project will abide by +All contributions to — and interactions surrounding — this project will abide by the [USGS Code of Scientific Conduct][1]. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96e163a9268..e751d48539d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -141,7 +141,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo ## Format Rules Fortran souce code format rules are met by running the -[fprettify formatter](https://github.com/pseewald/fprettify) while specifying the [MODFLOW 6 fprettify configuration](https://github.com/MODFLOW-USGS/modflow6/blob/develop/distribution/.fprettify.yaml). `fprettify` is included in the Conda `environment.yml` and can be run on the command line or integrated into a [VSCode](https://github.com/MODFLOW-USGS/modflow6/blob/develop/.vscode/README.md) or Visual Studio environment. +[fprettify formatter](https://github.com/pseewald/fprettify) while specifying the [MODFLOW 6 fprettify configuration](.fprettify.yaml). `fprettify` is included in the Conda `environment.yml` and can be run on the command line or integrated into a [VSCode](.vscode/README.md) or Visual Studio environment. The configuration file reflects the current minimum standard for Fortran source formatting. The main goal, however, is consistent and readable Fortran source code and as such pay particular attention to consistency within and across files. As the formatting tool may at times shift code in unexpected ways, check for formatting consistency after running. @@ -234,9 +234,3 @@ The body should include the motivation for the change and contrast this with pre The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**. **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. - - -[coc]: https://github.com/MODFLOW-USGS/modflow6/blob/develop/CODE_OF_CONDUCT.md -[dev-doc]: https://github.com/MODFLOW-USGS/modflow6/blob/develop/DEVELOPER.md -[github]: https://github.com/MODFLOW-USGS/modflow6 -[stackoverflow]: http://stackoverflow.com/questions/tagged/modflow6 diff --git a/DEVELOPER.md b/DEVELOPER.md index f120edf81a2..b64594806fa 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -191,7 +191,7 @@ These are each described briefly below. The Conda `environment.yml` contains a n ##### `fprettify` -[`fprettify`](https://github.com/pseewald/fprettify) can be used to format Fortran source code and in combination with the [MODFLOW 6 fprettify configuration](https://github.com/MODFLOW-USGS/modflow6/blob/develop/distribution/.fprettify.yaml) establishes a contribution standard for properly formatted MODFLOW 6 Fortran source. This tool can be installed with `pip` or `conda` and used from the command line or integrated with a [VSCode](https://github.com/MODFLOW-USGS/modflow6/blob/develop/.vscode/README.md) or Visual Studio development environment. The `fprettify` package is included in the Conda environment in `environment.yml`. See [contribution guidelines](https://github.com/MODFLOW-USGS/modflow6/blob/develop/CONTRIBUTING.md) for additional information. +[`fprettify`](https://github.com/pseewald/fprettify) can be used to format Fortran source code and in combination with the [MODFLOW 6 fprettify configuration](.fprettify.yaml) establishes a contribution standard for properly formatted MODFLOW 6 Fortran source. This tool can be installed with `pip` or `conda` and used from the command line or integrated with a [VSCode](.vscode/README.md) or Visual Studio development environment. The `fprettify` package is included in the Conda environment in `environment.yml`. See [contribution guidelines](CONTRIBUTING.md) for additional information. ##### `mfpymake`