Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DE-58 updated readme to sync to jira #2

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

DE-58 updated readme to sync to jira #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c277a69
chore: add sonarcloud badges in readme
stephanoshadjipetrou Aug 4, 2022
126dcc3
DE-58 updated readme to sync to jira
sylvanr Sep 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

---

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/globalfund/data-explorer-server/blob/main/LICENSE.MD)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/globalfund/data-explorer-server/blob/main/LICENSE.MD) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=globalfund_data-explorer-server&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=globalfund_data-explorer-server) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=globalfund_data-explorer-server&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=globalfund_data-explorer-server) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=globalfund_data-explorer-server&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=globalfund_data-explorer-server)

## What is the Data Explorer API?

Expand Down Expand Up @@ -77,3 +77,7 @@ chore: Changes to the build process or auxiliary tools and libraries such as doc
- Avoid huge code commits where the difference can not even be rendered by browser based web apps (Github for example). Smaller commits make it much easier to understand why and how the changes were made, why (if) it results in certain bugs and etc.
- If there's a reason to commit code that is commented out (there usually should be none), always leave a "FIXME" or "TODO" comment so it's clear for other developers why this was done.
- Automatic code quality / testing checks (continuous integration tools) are implemented to check all these things automatically when pushing / merging new branches. Quality is the key!

# Synchronisation with Jira
Checkout a new branch in your repo, using the issue key in the branch name. For example, `git checkout -b DE-58-sync-data-explorer-server-to-jira`
When committing changes to your branch, use the issue key in your commit message to link those commits to the development panel in your Jira issue. For example, `git commit -m "DE-58 <summary of commit>"`