Skip to content

Latest commit

 

History

History
108 lines (83 loc) · 4.29 KB

CONTRIBUTING.md

File metadata and controls

108 lines (83 loc) · 4.29 KB
Raw

Contributing to landlab tutorials

Thank you for contributing to the landlab tutorials! We appreciate your help as this is largely as volunteer effort! ❤️ ❤️ ❤️

How to contribute

Reporting Bugs

Before creating a bug report, please do at least a cursory check that the bug has not already been reported. If it has, add a comment to the existing issue instead of opening a new one.

Submitting a Bug Report

Bugs are tracked as GitHub issues. After you've determined you've found a new bug, please open a new issue.

Explain the problem and include additional details to help maintainers reproduce the problem. Here are some items that will make it easier to track down the source of the problem.

  • Use a clear and descriptive title for the issue that identifies the problem.
  • Describe the exact steps that reproduce the problem.
  • If possible, provide an example that demonstrates the step as, for example, a bash script along with input files.
  • Describe the behavior you are seeing after these steps.
  • Describe the behavior you expect to see after these steps.

Additionally, the answers to the following questions about your run environment will be helpful.

  • Which version of landlab are you using? This could be a specific git sha or a release number.
  • What is he name and version of you OS?
  • What compiler are you using?
  • How did you build landlab (if using the development version)?

Submitting Changes

🎉 Whoa! This is great! We love it when folks contibute code! 🎉

Changes to landlab tutorials should be submitted as pull requests).

  • Create a GitHub issue that describes what you propose to do.
  • Create a topic branch that contains your changes.
  • Open a new GitHub pull request.
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number.

Styleguides

Use the PEP8 style guide. You may want to use tools like Prospector to help out with this.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 👕 :shirt: when removing linter warnings

Adding new tutorials

If you would like to create a new tutorial that we have just a few conventions that we would like you to follow.

  • Create a new folder that will hold your tutorial notebook and data used by your tutorial.
  • Start with the blank tutorial template provided in this repository.
  • Notice that your first cell of code should import print_function from __future__. Your tutorial will need to be compatible with both Python 2.7 and 3.4+.
  • If you will be plotting anything, be sure to use include ipython magic command in the first cell to indicate how plots should be rendered.
  • Your tutorial must be able to run without error for the most recent landlab release.
  • If your tutorial runs with the most recent release of landlab, a pull request should be sent to the release branch.
  • If you tutorial does not work with the most recent release but does work with a development version of landlab that's yet to be release, submit a pull request to the next branch.

Thanks! ❤️ ❤️ ❤️

The landlab team