Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 3.37 KB
Raw

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.

Updates to the GEOS-Chem model benefit both you and the entire GEOS-Chem community. You benefit through coauthorship and citations. Priority development needs are identified at GEOS-Chem users' meetings with updates between meetings based on GEOS-Chem Steering Committee (GCSC) input through Working Groups.

We use GitHub

We use GitHub to host the GEOS-Chem website files. to track issues, user questions, and feature requests, and to accept pull requests: https://github.com/geoschem/geoschem.github.io. Please help out as you can in response to issues and user questions.

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 features as they are ready.

The practical aspects of submitting updates are listed below.

How can I submit updates?

We use GitHub Flow, so all changes happen through pull requests. This workflow is described here.

As the author you are responsible for:

  • Testing your changes
  • Updating the user documentation (if applicable)
  • Supporting issues and questions related to your changes

Process for submitting updates

  1. Create or log into your GitHub account.
  2. Fork the geoschem.github.io repository into your Github account.
  3. Clone your fork of geoschem.github.io to your computer system.
  4. Add your modifications into a new branch off the main branch.
  5. Test your website updates thoroughly. We recommend using a couple of different browsers on both computer and mobile devices to check if the web pages render properly.
  6. Create a pull request in GitHub.
  7. The GEOS-Chem Support Team will merge your updates into the main branch. Once this happens, your updates will be visible on the wb.
  8. If your website updates break existing functionality, the GCST will request that you take further corrective action.

How can I request a new feature?

We accept feature requests through issues on GitHub. To request a new feature, open a new issue 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.

Where can I ask for help?

Please see Support Guidelines.