Skip to content

Commit

Permalink
Update links in CONTRIBUTING.md and SUPPORT.md
Browse files Browse the repository at this point in the history
Several of the web links in the CONTRIBUTING.md and SUPPORT.md files
had gone stale.  We have now updated them to point to the new
GEOS-Chem website https://geoschem.github.io.

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
  • Loading branch information
yantosca committed Oct 13, 2023
1 parent ad68c48 commit 9c0bfdc
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Thank you for looking into contributing to GEOS-Chem! GEOS-Chem is a grass-roots model that relies on contributions from community members like you. Whether you're new to GEOS-Chem or a longtime user, you're a valued member of the community, and we want you to feel empowered to contribute.

Updates to the GEOS-Chem model benefit both you and the [entire GEOS-Chem community](https://geoschem.github.io/geos-chem-people-projects-map/). You benefit through [coauthorship and citations](https://geos-chem.seas.harvard.edu/geos-new-developments). Priority development needs are identified at GEOS-Chem users' meetings with updates between meetings based on [GEOS-Chem Steering Committee (GCSC)](https://geos-chem.seas.harvard.edu/geos-steering-cmte) input through [Working Groups](https://geos-chem.seas.harvard.edu/geos-working-groups).
Updates to the GEOS-Chem model benefit both you and the [entire GEOS-Chem community](https://geoschem.github.io/people.html). You benefit through [coauthorship and citations](https://geoschem.github.io/new-developments.html). Priority development needs are identified at GEOS-Chem users' meetings with updates between meetings based on [GEOS-Chem Steering Committee (GCSC)](https://geoschem.github.io/steering-committee.html) input through [Working Groups](https://geoschem.github.io/working-groups.html).

## We use GitHub and ReadTheDocs
We use GitHub to host the GEOS-Chem Classic source code, to track issues, user questions, and feature requests, and to accept pull requests: [https://github.com/geoschem/geos-chem](https://github.com/geoschem/geos-chem). Please help out as you can in response to issues and user questions.
Expand Down Expand Up @@ -36,7 +36,7 @@ As the author you are responsible for:
7. Test your update thoroughly and make sure that it works. For structural updates we recommend performing a difference test (i.e. testing against the prior version) in order to ensure that identical results are obtained).
8. Review the coding conventions and checklists for code and data updates listed below.
9. Create a [pull request in GitHub](https://help.github.com/articles/creating-a-pull-request/).
10. The [GEOS-Chem Support Team](https://wiki.geos-chem.org/GEOS-Chem_Support_Team) will add your updates into the development branch for an upcoming GEOS-Chem version. They will also validate your updates with [benchmark simulations](https://wiki.geos-chem.org/GEOS-Chem_benchmarking).
10. The [GEOS-Chem Support Team](https://geoschem.github.io/support-team.html) will add your updates into the development branch for an upcoming GEOS-Chem version. They will also validate your updates with [benchmark simulations](http://wiki.geos-chem.org/GEOS-Chem_benchmarking).
11. If the benchmark simulations reveal a problem with your update, the GCST will request that you take further corrective action.

### Coding conventions
Expand Down Expand Up @@ -72,7 +72,7 @@ Also follow these additional steps to ensure that your data can be read by GCHP:
We accept feature requests through issues on GitHub. To request a new feature, **[open a new issue](https://github.com/geoschem/geos-chem/issues/new/choose)** and select the feature request template. Please include all the information that migth be relevant, including the motivation for the feature.

## How can I report a bug?
Please see **[Support Guidelines](https://geos-chem.readthedocs.io/en/stable/reference/SUPPORT.html)**.
Please see **[Support Guidelines](https://geos-chem.readthedocs.io/en/stable/help-and-reference/SUPPORT.html)**.

## Where can I ask for help?
Please see **[Support Guidelines](https://geos-chem.readthedocs.io/en/stable/reference/SUPPORT.html)**
Please see **[Support Guidelines](https://geos-chem.readthedocs.io/en/stable/help-and-reference/SUPPORT.html)**
8 changes: 4 additions & 4 deletions SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ We use GitHub issues to support user questions. To ask a question, **[open a new

## What type of support can I expect?

We will be happy to assist you in resolving bugs and technical issues that arise when compiling or running GEOS-Chem. User support and outreach is an important part of our mission to support the [International GEOS-Chem User Community](https://geoschem.github.io/geos-chem-people-projects-map/).
We will be happy to assist you in resolving bugs and technical issues that arise when compiling or running GEOS-Chem. User support and outreach is an important part of our mission to support the [International GEOS-Chem User Community](https://geoschem.github.io/people.html).

Even though we can assist in several ways, we cannot possibly do everything. We rely on GEOS-Chem users being resourceful and willing to try to resolve problems on their own to the greatest extent possible.

If you have a science question rather than a technical question, you should contact the relevant [GEOS-Chem Working Group(s)](https://geos-chem.seas.harvard.edu/geos-working-groups) directly. But if you do not know whom to ask, you may open a new issue (See "Where can I ask for help" above) and we will be happy to direct your question to the appropriate person(s).
If you have a science question rather than a technical question, you should contact the relevant [GEOS-Chem Working Group(s)](https://geoschem.github.io/working-groups.html) directly. But if you do not know whom to ask, you may open a new issue (See "Where can I ask for help" above) and we will be happy to direct your question to the appropriate person(s).

## How to submit changes
Please see **[Contributing Guidelines](https://geos-chem.readthedocs.io/en/stable/reference/CONTRIBUTING.html)**.
Please see **[Contributing Guidelines](https://geos-chem.readthedocs.io/en/stable/help-and-reference/CONTRIBUTING.html)**.

## How to request an enhancement
Please see **[Contributing Guidelines](https://geos-chem.readthedocs.io/en/stable/reference/CONTRIBUTING.html)**.
Please see **[Contributing Guidelines](https://geos-chem.readthedocs.io/en/stable/help-and-reference/CONTRIBUTING.html)**.

0 comments on commit 9c0bfdc

Please sign in to comment.