Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

33 lines (27 loc) · 1.72 KB
Raw

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Scrum-Mastery and its repository, which are hosted in the Scrum-Mastery on GitHub. These are mostly guidelines, not rules.

Use your best judgment, and feel free to propose changes to this document in a pull request.

In the README file you will find the purpose and goal of this open project, also brief how to use GitHub. Please read the Code of Conduct and Licence agreement.

Git Commit Messages

  • Use Markdown, here a cheatsheet.
  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable emoji: 🎨 🎨 when improving the format/structure of the code 🐎 🐎 when improving performance 📝 📝 when writing docs 🐛 🐛 when fixing a bug 🔥 🔥 when removing code or files ✅ ✅ when adding tests 🔒 🔒 when dealing with security ⬆️ ⬆️ when upgrading dependencies ⬇️ ⬇️ when downgrading dependencies

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."
> ```