Skip to content

Commit

Permalink
Update CONTRIBUTING.md and SUPPORT.md w/ content from the GC wiki
Browse files Browse the repository at this point in the history 
We have added extra content from the GEOS-Chem wiki to the
CONTRIBUTING.md and SUPPORT.md pages.  This will allow us to
retire the wiki documentation in favor of just pointing to
CONTRIBUTING and SUPPORT on ReadTheDocs.

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
  • Loading branch information
@yantosca
yantosca committed Aug 15, 2022
1 parent dda7140 commit 73698f4
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 31 deletions.
80 changes: 62 additions & 18 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,34 +1,78 @@
## Contributing Guidelines
# Contributing Guidelines

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.
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.

#### We use GitHub and ReadTheDocs
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 the GEOS-Chem 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.

GEOS-chem documentation can be found on the [GEOS-Chem wiki](http://wiki.seas.harvard.edu/geos-chem/index.php/Main_Page)
GEOS-Chem documentation can be found at [geos-chem.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.

#### How to submit changes
We use [GitHub Flow](https://guides.github.com/introduction/flow/index.html), so all changes happen through pull requests. This
workflow is described here: [GitHub Flow](https://guides.github.com/introduction/flow/index.html).
Code related to model developments should be submitted when it is mature (i.e. a paper has been submitted). Your Working Croup 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.

## How can I submit updates?
We use [GitHub Flow](https://guides.github.com/introduction/flow/index.html), so all changes happen through pull requests. This workflow is [described here](https://guides.github.com/introduction/flow/index.html).

As the author you are responsible for:
- Testing your changes
- Updating the user documentation (if applicable)
- Supporting issues and questions related to your changes in the near-term
- Supporting issues and questions related to your changes

### Process for submitting code updates

#### Coding conventions
The GEOS-Chem codebase dates back several decades and includes contributions from many people and multiple organizations.
Therefore, some inconsistent conventions are inevitable, but we ask that you do your best to be consistent with nearby
1. Contact your GEOS-Chem Working Group leaders to request that your updates be added to GEOS-Chem. They will will forward your request to the GCSC.
2. The GCSC meets quarterly to set [GEOS-Chem model development priorities](http://wiki.geos-chem.org/GEOS-Chem_model_development_priorities). Your update will be slated for inclusion into an upcoming GEOS-Chem version.
3. Create or log into your [GitHub](https://github.com/) account.
4. [Fork the GEOS-Chem repository](https://help.github.com/articles/fork-a-repo/) into your Github account.
5. Clone your forks of the GEOS-Chem repositories to your computer system.
6. Add your modifications into a [new branch](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) off the **main** branch.
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).
11. If the benchmark simulations reveal a problem with your update, the GCST will request that you take further corrective action.

### Coding conventions
The GEOS-Chem codebase dates back several decades and includes contributions from many people and multiple organizations. Therefore, some inconsistent conventions are inevitable, but we ask that you do your best to be consistent with nearby
code.

#### How to request an enhancement
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.
### Checklist for submitting code updates

1. Use Fortran-90 free format instead of Fortran-77 fixed format.
2. Include thorough comments in all submitted code.
3. Include full citations for references at the top of relevant source code modules.
4. Remove extraneous code updates (e.g. testing options, other science).
5. Submit any related code or configuration files for [GCHP](https://gchp.readthedocs.io) along with code or configuration files for [GEOS-Chem Classic](https://geos-chem.readthedocs.io).

### Checklist for submitting data files

1. Choose a final file naming convention before submitting data files for inclusion to GEOS-Chem.
2. Make sure that all netCDF files [adhere to the COARDS conventions](https://geos-chem.readthedocs.io/en/latest/geos-chem-shared-docs/supplemental-guides/coards-guide.html).
3. [Concatenate netCDF files](https://geos-chem.readthedocs.io/en/latest/geos-chem-shared-docs/supplemental-guides/netcdf-guide.html#concatenate-netcdf-files) to reduce the number of files that need to be opened. This results in more efficient I/O operations.
4. [Chunk and deflate netCDF](https://geos-chem.readthedocs.io/en/latest/geos-chem-shared-docs/supplemental-guides/netcdf-guide.html#chunk-and-deflate-a-netcdf-file-to-improve-i-o) files in order to improve file I/O.
5. Include an updated [HEMCO configuration file](https://hemco.readthedocs.io/en/latest/hco-ref-guide/hemco-config.html) corresponding to the new data.
6. Include a README file detailing data source, contents, etc.
7. Include script(s) used to process original data
8. Include a summary or description of the expected results (e.g. emission totals for each species)

Also follow these additional steps to ensure that your data can be read by GCHP:

1. All netCDF data variables should be of type `float` (aka `REAL*4`) or `double` (aka `REAL*8`).
2. Use a recent reference datetime (i.e. after `1900-01-01`) for the netCDF `time:units` attribute.
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/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 to report a bug
## How can I report a bug?
Please see "Support Guidelines".

#### Where can I ask for help?
## Where can I ask for help?
Please see "Support Guidelines".
30 changes: 17 additions & 13 deletions SUPPORT.md
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
## Support Guidelines
# Support Guidelines

GEOS-Chem support is maintained by the GEOS-Chem Support Team (GCST).
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)](http://wiki.geos-chem.org/GEOS-Chem_Support_Team). The GCST members are based at Harvard University and Washington University in St. Louis.

We track bugs, user questions, and feature requests through GitHub issues.
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/geos-chem/issues/new/choose). Please include all the information that might be relevant, including simulation log files and instructions for replicating the bug.

#### How to report a bug
We use GitHub to track issues. To report a bug, [open a new issue](https://github.com/geoschem/geos-chem/issues/new/choose). Please include
all the information that might be relevant, including instructions for reproducing the bug.

#### Where can I ask for help?
## 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/geos-chem/issues/new/choose) and select the question template.

#### How to submit changes
## 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/).

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/geos-chem/issues/new/choose). and we will be happy to direct your question to the appropriate person(s).

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

#### How to request an enhancement
Please see "Contributing Guidelines".
## How to request an enhancement
Please see "Contributing Guidelines".

0 comments on commit 73698f4

Please sign in to comment.