CONTRIBUTING.md

Contributing guidelines

Contributing to CB-Geo LBM-DEM will require you to electronically signed a copy of the Contributor License Agreement (CLA).

Signing a contributor agreement is necessary for many reasons. For an overview, see http://oss-watch.ac.uk/resources/cla.

You can view the CLA at https://gist.github.com/cbgeo/7a8541e1d51f131be1d4b7444340dff1.

After we have signed the Copyright License Agreement via https://cla-assistant.io/, we will approve your GitHub account to make contributions. GitHub pull requests are the only acceptable facility for code submission. Please do not send patches by email.

Thank you for contributing!

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
  • 🚀 :rocket: when improving performance
  • 💡 :bulb: new idea
  • 📚 :books: To add new references
  • 🚧 :construction: work in progress
  • 💻 :computer: when adding feature
  • ✂️ :scissors: when removing feature
  • 🚱 :non-potable_water: when plugging memory leaks
  • ✏️ :pencil2: when writing docs
  • 🐧 :penguin: when fixing something on Linux
  • 🍎 :apple: when fixing something on macOS
  • 🏁 :checkered_flag: when closing pull requests
  • 🐛 :bug: when fixing a bug
  • 🔥 :fire: when removing code or files
  • 💚 :green_heart: when fixing the CI build
  • 🎯 :dart: when adding tests
  • 🔒 :lock: when dealing with security
  • ⬆️ :arrow_up: when upgrading dependencies
  • ⬇️ :arrow_down: when downgrading dependencies
  • 🔈 :speaker: when adding logging
  • 🔇 :mute: when reducing logging
  • 👕 :shirt: when removing linter warnings
  • 🔧 :wrench: Fixing broken stuff
  • 📎 :paperclip: Merge changes