Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

52 lines (36 loc) · 2.54 KB

How to contribute to Veracity

I'm really glad you're reading this, since we encurage developers to contribute to all and any code we publish on github.

If you haven't already, visit our developers corner at Veracity Developer. We want you working on things you're excited about.

Here are some important resources:

Submitting changes

Please send a GitHub Pull Request to Veracity with a clear list of what you've done (read more about pull requests). When you send a pull request, someone in our dev team will check out you code. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Styleguides

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 after the first line
  • 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
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings

Thanks, Brede Børhaug, Manager Veracity Developers Community