Skip to content

Commit

Permalink
Migrate feature proposal template to MarkDown
Browse files Browse the repository at this point in the history
  • Loading branch information
amomchilov committed Dec 12, 2024
1 parent a19f0b5 commit 7af1bc9
Showing 1 changed file with 24 additions and 13 deletions.
37 changes: 24 additions & 13 deletions doc/contributing/reporting_issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,19 +52,30 @@ your feature it could help persuade Ruby core.

Here is a template you can use for a feature proposal:

```
[Abstract]
Briefly summarize your feature
[Background]
Describe current behavior
[Proposal]
Describe your feature in detail
[Use cases]
Give specific example uses of your feature
[Discussion]
Describe why this feature is necessary and better than using existing features
[See also]
Link to other related resources (such as implementations in other languages)
```markdown
# Abstract

Briefly summarize your feature

# Background

Describe current behavior

# Proposal

Describe your feature in detail

# Use cases

Give specific example uses of your feature

# Discussion

Describe why this feature is necessary and better than using existing features

# See also

Link to other related resources (such as implementations in other languages)
```

## Backport requests
Expand Down

0 comments on commit 7af1bc9

Please sign in to comment.