Skip to content

Latest commit

 

History

History
60 lines (32 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

60 lines (32 loc) · 4.05 KB
Raw

Contributors Guide

Thank you for considering contributing to SubZero!

Feel free to ask us questions and chat with us at any time about any topic at all by

We follow the ColPrac guide for collaborative practices. We ask that new contributors read that guide before submitting a pull request.

Creating issues

The simplest way to contribute to SubZero is to create or comment on issues and discussions.

The most useful bug reports:

  • Provide an explicit code snippet --- not just a link --- that reproduces the bug in the latest tagged version of SubZero. This is sometimes called the "minimal working example". Reducing bug-producing code to a minimal example can dramatically decrease the time it takes to resolve an issue.

  • Paste the entire error received when running the code snippet, even if it's unbelievably long.

  • Use triple backticks (```) to enclose code snippets, and other markdown formatting syntax to make your issue easy and quick to read.

  • Report the SubZero version, and any other possibly useful details of the computational environment in which the bug was created.

Discussions are recommended for asking questions about (for example) the user interface, implementation details, science, and life in general.

But I want to code!

  • New users help write SubZero code and documentation by forking the SubZero repository, using git to edit code and docs, and then creating a pull request. Pull requests are reviewed by SubZero collaborators.

  • A pull request can be merged once it is reviewed and approved by collaborators. If the pull request author has write access, they have the responsibility of merging their pull request. Otherwise, SubZero collaborators will execute the merge with permission from the pull request author.

  • Note: for small or minor changes (such as fixing a typo in documentation), the GitHub editor is super useful for forking and opening a pull request with a single click.

  • Write your code with love and care. In particular, conform to existing SubZero style and formatting conventions.

What is a "collaborator" and how can I become one?

  • Collaborators have permissions to review pull requests and status allows a contributor to review pull requests in addition to opening them. Collaborators can also create branches in the main SubZero repository.

  • We ask that new contributors try their hand at forking SubZero, and opening and merging a pull request before requesting collaborator status.

What's a good way to start developing SubZero?

  • Begin running one of the provided test cases.

  • Try to run SubZero and play around with it to simulate your favorite sea ice scenario. If you run into any bugs/problems or find it difficult to use or understand, please open an issue!

  • Write up an example or tutorial on how to do something useful with SubZero, like how to set up a new physical configuration.

  • Improve documentation or comments if you found something hard to use.

  • Implement a new feature if you need it to use SubZero.

If you're interested in working on something, let us know by commenting on existing issues or by opening a new issue. This is to make sure no one else is working on the same issue and so we can help guide you in case there is anything you need to know beforehand.