Skip to content
This repository has been archived by the owner on Oct 2, 2021. It is now read-only.

[Optional] Add Formatting Suggestions #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,59 @@ Not all KIPs need to be gov proposals that end up on-chain - they can outline va

To propose a new KIP, you should copy the `kips/_template.md` file to a new file named something like `kips/KIP01 - Some Proposal Title.md`, fill out the relevant parts, and then open a new pull request against the master branch. From there you should post in the Kolibri Discord (and possibly tweet about it using the #kolibri tag), and folks can show their support via 👍/👎 emojis on the PR itself, as well as ask whatever questions they have.

Note that not all KIPs will be complete at submission time and may have open action items.

## Adoption

Once things have had deliberation period of at least 3 days, the PR will be merged, which should coincide with whatever actions need to be carried out (a proposal being submitted to the DAO - linking to the proposal, or any other things necessary by whomever can do it).

## Helpful Formatting Tips

KIPs are [Markdown](https://www.markdownguide.org/basic-syntax/) files and you can apply some formatting. Common uses patterns below:

### Subheadings

Use:
```
# Main Heading
## Sub Heading
### Sub Sub Heading
````

Renders as:
> # Main Heading
> ## Sub Heading
> ### Sub Sub Heading

### Bold and Italics

Use:
```
*italic*
**bold**
```

Renders as:

> *italic*
>
>**bold**

### TODOs

If you have an item to discuss, use:
```
🗒️ ⬜ <!-- ✅ --> TODO(your_github_name): Discuss with community \<thing to discuss\>
```

Renders as:

> 🗒️ ⬜ <!-- ✅ --> **TODO(your_github_name): Discuss with community \<thing to discuss\>**

When resolved, you can either remove the line, or keep it for historical purposes by ammending to:
```
🗒️ ✅ Discussed with community \<thing to discuss\>. See comments in [pull request](https://github.com/hover-labs/kolibri-improvement-proposals/pulls/<PR #>)
```

Which renders as:
> 🗒️ ✅ Discussed with community \<thing to discuss\>. See comments in [pull request](https://github.com/hover-labs/kolibri-improvement-proposals/pulls/<PR #>)