Skip to content

Commit

Permalink
Update CONTRIBUTING.md and SUPPORT.md to instruct users to open issues
Browse files Browse the repository at this point in the history 
CONTRIBUTING.md
- Based on GCClassic/CONTRIBUTING.md
- Place boldface around "open a new issue"link

SUPPORT.md
- Based on GCClassic/SUPPORT.md
- Remove GCST wiki link
- Place boldface around "open a new issue" links
- Instruct users to add their name and institution in the issues

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
  • Loading branch information
@yantosca
yantosca committed Jan 27, 2023
1 parent cf1afc1 commit 13fdb7c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Thank you for looking into contributing to GEOS-Chem! GEOS-Chem is a grass-roots
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).

## We use GitHub and ReadTheDocs
We use GitHub to host GCHP source code, to track issues, user questions, and feature requests, and to accept pull requests: [https://github.com/geoschem/GCHP](https://github.com/geoschem/gchp). Please help out as you can in response to issues and user questions.
We use GitHub to host the GCHP source code, to track issues, user questions, and feature requests, and to accept pull requests: [https://github.com/geoschem/GCHP](https://github.com/geoschem/GCHP). Please help out as you can in response to issues and user questions.

GCHP documentation can be found at [gchp.readthedocs.io](https://gchp.readthedocs.io).
GCHP Classic documentation can be found at [gchp.readthedocs.io](https://geos-chem.readthedocs.io).

## When should I submit updates?

Submit bug fixes right away, as these will be given the highest priority. Please see "Support Guidelines" for more information.

Submit updates (code and/or data) for mature model developments once you have submitted a paper on the topic. Your Working Group chair can offer guidance on the timing of submitting code for inclusion into GCHP.
Submit updates (code and/or data) for mature model developments once you have submitted a paper on the topic. Your Working Group chair can offer guidance on the timing of submitting code for inclusion into GEOS-Chem.

The practical aspects of submitting code updates are listed below.

Expand Down Expand Up @@ -69,7 +69,7 @@ Also follow these additional steps to ensure that your data can be read by GCHP:
3. The first time value in each file should be 0, corresponding with the reference datetime.

## How can I request a new feature?
We accept feature requests through issues on GitHub. To request a new feature, [open a new issue](https://github.com/geoschem/GCHP/issues/new/choose) and select the feature request template. Please include all the information that migth be relevant, including the motivation for the feature.
We accept feature requests through issues on GitHub. To request a new feature, **[open a new issue](https://github.com/geoschem/GCHP/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".
Expand Down
13 changes: 7 additions & 6 deletions SUPPORT.md
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
# Support Guidelines

GEOS-Chem support is maintained by the [GEOS-Chem Support Team (GCST)](http://wiki.geos-chem.org/GEOS-Chem_Support_Team). The GCST members are based at Harvard University and Washington University in St. Louis.
GEOS-Chem support is maintained by the **GEOS-Chem Support Team
(GCST)**, which is based jointly at Harvard University and Washington University in St. Louis.

We track bugs, user questions, and feature requests through [GitHub issues](https://www.youtube.com/watch?v=dFBhdotYVf8). Please help out as you can in response to issues and user questions.
We track bugs, user questions, and feature requests through **[GitHub issues](https://www.youtube.com/watch?v=dFBhdotYVf8)**. Please help out as you can in response to issues and user questions.

## How to report a bug
We use GitHub to track issues. To report a bug, [open a new issue](https://github.com/geoschem/GCHP/issues/new/choose). Please include all the information that might be relevant, including simulation log files and instructions for replicating the bug.
We use GitHub to track issues. To report a bug, **[open a new issue](https://github.com/geoschem/GCHP/issues/new/choose)**. Please include your name, institution, and all relevant information, such as simulation log files and instructions for replicating the bug.

## Where can I ask for help?
We use GitHub issues to support user questions. To ask a question, [open a new issue](https://github.com/geoschem/GCHP/issues/new/choose) and select the question template.
We use GitHub issues to support user questions. To ask a question, **[open a new issue](https://github.com/geoschem/GCHP/issues/new/choose)** and select the question template. Please include your name and institution in the issue.

## 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/geos-chem-people-projects-map/).

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](https://github.com/geoschem/GCHP/issues/new/choose). 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://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).

## How to submit changes
Please see "Contributing Guidelines".
Expand Down

0 comments on commit 13fdb7c

Please sign in to comment.