Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

84 lines (63 loc) · 3.18 KB

Contributing to CEM

Thank you for contributing to CEM! We appreciate your help as this is mostly 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 descriptinve 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 CEM 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 compile CEM?

Submitting Changes

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

Changes to CEM 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

Try to use the Google C++ styleguide. You may want to use ~/clang-format -style=Google to help 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

Thanks! ❤️ ❤️ ❤️

The CEM team