hcengineering / hcengineering/platform

Document / Issues import format

Open
#6,625 0 comments 0 reactions 1 assignee Claimed by @BykhovDenis View on GitHub
Dominant language
TypeScript
Stars
27.7k
Forks
2.2k
PR merge metrics
No merged PRs in 30d

Description

Current format is not correct, we do not need it to be yaml, it’s fragile to make Yaml files in text editor, at least because of indent sensitivity, so instead of:

```
_class: 'Issue'
number: 1
status: 'Todo'
title: 'Create your first project 📌'
identifier: 'HULY-1'
description: |
### **Welcome to Huly, your all-in-one project management platform!**

Embark on an...
```

we should have Markdown files with YAML metadata ([Frontmatter](https://jekyllrb.com/docs/front-matter/)). Such files looks like below and technically they are NOT yaml files, so they should have .md extension to be properly recognized by text editors:

```markdown
_class: 'Issue'
number: 1
status: 'Todo'
title: 'Create your first project 📌'
identifier: 'HULY-1'
---
### **Welcome to Huly, your all-in-one project management platform!**

Embark on an...
```

Huly®: UBERF-8172

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.