diff --git a/.pep8speaks.yml b/.pep8speaks.yml index d6a129ad9..902771cfc 100644 --- a/.pep8speaks.yml +++ b/.pep8speaks.yml @@ -4,7 +4,7 @@ message: # Customize the comment made by the bot opened: # Messages when a new PR is submitted header: "Hello @{name}, Thank you for submitting the Pull Request !" # The keyword {name} is converted into the author's username - footer: "If you have not done so, please consult the [`jwql` Style Guide](https://github.com/spacetelescope/jwql/blob/master/style_guide/README.md)" + footer: "If you have not done so, please consult the [`jwql` Style Guide](https://github.com/spacetelescope/jwql/blob/main/style_guide/README.md)" # The messages can be written as they would over GitHub updated: # Messages when new commits are added to the PR header: "Hello @{name}, Thank you for updating !" diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index a00b827c2..a99e7dd0c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -57,5 +57,5 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai This Code of Conduct is adapted from several existing code of conducts: - The [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/) -- The [`stsci-package-template` code of conduct](https://github.com/spacetelescope/stsci-package-template/blob/master/CODE_OF_CONDUCT.md) +- The [`stsci-package-template` code of conduct](https://github.com/spacetelescope/stsci-package-template/blob/main/CODE_OF_CONDUCT.md) - The [`scipy` code of conduct](https://docs.scipy.org/doc/scipy/reference/dev/conduct/code_of_conduct.html) diff --git a/README.md b/README.md index 94f46dd14..eab8cea8d 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ # The JWST Quicklook Application (`JWQL`) [![Current Release](https://img.shields.io/github/release/spacetelescope/jwql.svg)](https://github.com/spacetelescope/jwql/releases/latest/) -[![PyPI - License](https://img.shields.io/pypi/l/Django.svg)](https://github.com/spacetelescope/jwql/blob/master/LICENSE) +[![PyPI - License](https://img.shields.io/pypi/l/Django.svg)](https://github.com/spacetelescope/jwql/blob/main/LICENSE) [![Python](https://img.shields.io/badge/Python-3.6-blue.svg)](https://www.python.org/) -[![Build Status](https://ssbjenkins.stsci.edu/job/STScI/job/jwql/job/master/badge/icon)](https://ssbjenkins.stsci.edu/job/STScI/job/jwql/job/master/) +[![Build Status](https://ssbjenkins.stsci.edu/job/STScI/job/jwql/job/main/badge/icon)](https://ssbjenkins.stsci.edu/job/STScI/job/jwql/job/main/) [![Documentation Status](https://readthedocs.org/projects/jwql/badge/?version=latest)](https://jwql.readthedocs.io/en/latest/?badge=latest) [![STScI](https://img.shields.io/badge/powered%20by-STScI-blue.svg?colorA=707170&colorB=3e8ddd&style=flat)](http://www.stsci.edu) [![codecov](https://codecov.io/gh/spacetelescope/jwql/branch/develop/graph/badge.svg)](https://codecov.io/gh/spacetelescope/jwql) @@ -108,7 +108,7 @@ Much of the `jwql` software depends on the existence of a `config.json` file wit ## Software Contributions -There are two current pages to review before you begin contributing to the `jwql` development. The first is our [style guide](https://github.com/spacetelescope/jwql/blob/master/style_guide/README.md) and the second is our [suggested git workflow page](https://github.com/spacetelescope/jwql/wiki/git-&-GitHub-workflow-for-contributing), which contains an in-depth explanation of the workflow. +There are two current pages to review before you begin contributing to the `jwql` development. The first is our [style guide](https://github.com/spacetelescope/jwql/blob/main/style_guide/README.md) and the second is our [suggested git workflow page](https://github.com/spacetelescope/jwql/wiki/git-&-GitHub-workflow-for-contributing), which contains an in-depth explanation of the workflow. Contributors are also encouraged to check out the [Checklist for Contributors Guide](https://github.com/spacetelescope/jwql/wiki/Checklist-for-Contributors-and-Reviewers-of-Pull-Requests) to ensure the pull request contains all of the necessary changes. @@ -136,7 +136,7 @@ Users who wish to report an issue or request a new feature may do so through the ## Code of Conduct -Users and contributors to the `jwql` repository should adhere to the [Code of Conduct](https://github.com/spacetelescope/jwql/blob/master/CODE_OF_CONDUCT.md). Any issues or violations pertaining to the Code of Conduct should be brought to the attention of a `jwql` team member or to `jwql@stsci.edu`. +Users and contributors to the `jwql` repository should adhere to the [Code of Conduct](https://github.com/spacetelescope/jwql/blob/main/CODE_OF_CONDUCT.md). Any issues or violations pertaining to the Code of Conduct should be brought to the attention of a `jwql` team member or to `jwql@stsci.edu`. ## Questions diff --git a/WEBPAGE_TEMPLATE.md b/WEBPAGE_TEMPLATE.md index 16bd164e3..5038e508d 100644 --- a/WEBPAGE_TEMPLATE.md +++ b/WEBPAGE_TEMPLATE.md @@ -13,7 +13,7 @@ The files and functions on the `webpage-template` branch that are designed to be | **URL entry template** | list item that maps a URL to a view | `jwql/website/apps/jwql/urls.py` | | **data container function** | python function that manipulates data for the view function | `website_template_data()` in `jwql/website/apps/jwql/data_containers.py` | -*To learn more about topics like HTML templates, views, and URLs, see the [JWQL intro to web apps](https://github.com/spacetelescope/jwql/blob/master/presentations/JWQL_web_app.pdf).* +*To learn more about topics like HTML templates, views, and URLs, see the [JWQL intro to web apps](https://github.com/spacetelescope/jwql/blob/main/presentations/JWQL_web_app.pdf).* diff --git a/jwql/utils/monitor_template.py b/jwql/utils/monitor_template.py index ae6d46d9a..6fddd49bd 100644 --- a/jwql/utils/monitor_template.py +++ b/jwql/utils/monitor_template.py @@ -46,7 +46,7 @@ Any monitoring script written for ``jwql`` must adhere to the ``jwql`` style guide located at: - https://github.com/spacetelescope/jwql/blob/master/style_guide/README.md + https://github.com/spacetelescope/jwql/blob/main/style_guide/README.md """ import os diff --git a/jwql/website/apps/jwql/templates/engineering_database.html b/jwql/website/apps/jwql/templates/engineering_database.html index 4e5b1ae10..f6189f2f8 100644 --- a/jwql/website/apps/jwql/templates/engineering_database.html +++ b/jwql/website/apps/jwql/templates/engineering_database.html @@ -12,7 +12,7 @@

Explore mnemonics in the DMS Engineering Database

- This page allows interactive exploration of mnemonics stored in the Engineering Database (EDB) powered by MAST. Its use requires access privileges to the EDB (see instructions page). Functionality is built on top of the astroquery.mast module. Example programmatic code for EDB queries is available in this Jupyter notebook. + This page allows interactive exploration of mnemonics stored in the Engineering Database (EDB) powered by MAST. Its use requires access privileges to the EDB (see instructions page). Functionality is built on top of the astroquery.mast module. Example programmatic code for EDB queries is available in this Jupyter notebook.


diff --git a/style_guide/accessibility_guidelines.md b/style_guide/accessibility_guidelines.md index 03651605e..2d726297e 100644 --- a/style_guide/accessibility_guidelines.md +++ b/style_guide/accessibility_guidelines.md @@ -1,7 +1,7 @@ Guidelines for Accessible Development ===================================== -This document serves as a guide for developing accessible web pages and code within the `jwql` project. Any contribution to the `jwql` code repository should be checked against these guidelines to ensure it meets all applicable standards. Any violations of these guidelines should be fixed before the code is committed to the `master` or `develop` branches. +This document serves as a guide for developing accessible web pages and code within the `jwql` project. Any contribution to the `jwql` code repository should be checked against these guidelines to ensure it meets all applicable standards. Any violations of these guidelines should be fixed before the code is committed to the `main` or `develop` branches. `jwql`-specific Guidelines diff --git a/style_guide/logging_guide.md b/style_guide/logging_guide.md index d8367802d..a570494c3 100644 --- a/style_guide/logging_guide.md +++ b/style_guide/logging_guide.md @@ -1,7 +1,7 @@ Logging Style Guide for `jwql` Instrument Monitors ================================================== -This document serves as a style guide for adding logging to `jwql` instrument monitor software. Any monitoring contribution to the `jwql` code repository should be checked against this guide to ensure proper usage of logging functions, and any violation of this and the style guide should be fixed before the code is committed to the `master` or `develop` branches. Please refer to the accompanying [`example.py`](https://github.com/spacetelescope/jwql/blob/master/style_guide/example.py) script for a example code that abides by the style guide and the logging guide. +This document serves as a style guide for adding logging to `jwql` instrument monitor software. Any monitoring contribution to the `jwql` code repository should be checked against this guide to ensure proper usage of logging functions, and any violation of this and the style guide should be fixed before the code is committed to the `main` or `develop` branches. Please refer to the accompanying [`example.py`](https://github.com/spacetelescope/jwql/blob/main/style_guide/example.py) script for a example code that abides by the style guide and the logging guide. Introduction