Skip to content

Latest commit

 

History

History
110 lines (85 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

110 lines (85 loc) · 3.46 KB
Raw

This file contains guidelines that should be followed when making any changes to the repository.

Code of Conduct

[ADD CONTENT HERE or DELETE SECTION]

Please read Angular Code of Conduct.

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

[ADD CONFLUENCE CONTENT HERE or TODOs]

Refer Angular Checklist & Google's JavaScript Style Guide for general guidelines.

Commit Message Guidelines

  • Communicating the nature of changes to teammates, the public, and other stakeholders.
  • Triggering build and publish processes.
  • Making it easier for people to contribute to multiple projects, by allowing them to explore a more structured commit history.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Please read Conventional Commits

Allowed <type>

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • update: New additions to existing feature
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests
  • revert: If the commit reverts a previous commit
Allowed <scope>

The scope can be a name of feature or Jira ticket number

Allowed <description>

This is a very short description of the change.

  • use imperative, present tense: “change” not “changed” nor “changes”
  • don't capitalize first letter
  • no dot (.) at the end
Allowed <footer>

The footer should contain any information about Breaking Changes. Also to reference ticket numbers(>1) that this commit Closes.

  • A BREAKING CHANGE can be part of commits of any type.

Example Commit mesages

feat(lang): add spanish language

update(lang): added missing spanish translations

fix(UM-111): added null-check before API

update(html/css): a bit of html/css refactoring/updating.

revert: This reverts commit <hash>

style: add missing semicolons

docs: correct spelling of CHANGELOG

refactor!: moved search-results to shared

refactor!: drop support for Node 8

BREAKING CHANGE: refactor to use JavaScript features not available in Node 8.

PR Guidelines

Before you submit your Pull Request (PR) consider the following guidelines:

  • Create branch with bitbucket or follow below naming format {type}/{name}
    • type: feature, bugfix
    • name: Title of Jira ticket, implemented feature
  • Please include the checklist from PR Checklist while creating PR.