Contribution: Pull Request - marian13/convenient_service GitHub Wiki

Follow the branch name pattern

Make sure your branch name matches the following pattern:

CS-\d+_short_description

CS means Convenient Service.

- dash separator between CS and \d+, for example, CS-9.

\d+ - issue number if you have one (or the first letter of your name 🙂).

_ - underscore separator between CS-\d and short description.

short_description - anything that makes sense in the context of branch, words are split by underscores.

Examples:

CS-7_use_three_dots

CS-8_methods_middlewares_callers_specs

CS-Y_conjunction_procs_evaluation

Follow Conventional Commits for commit messages

• Conventional Commits.

• Rules.

• The Angular convention.

Commit scope can be any lib component like in feat(core), refactor(utils), fix(support), plugin names - perf(has_result), test(normalizes_env), specific files - docs(README), chore(gemspec), etc.

That is not so important if you create a new tag, make sure the whole commit message makes sense.

NOTE: CHANGELOG.md is autogenerated from conventional commits.

Start the commit message with a verb in its infinitive form

For example:

• add specs,
• update docs,
• introduce new plugin,
• modify behavior,
• delete outdated method...