Skip to content

Commit f95e10b

Browse files
magnusrigamagnusriga
committed
docs: update changelog for v0.1.0
1 parent ba1fa5e commit f95e10b

File tree

6 files changed

+127
-5
lines changed

6 files changed

+127
-5
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
15+
1. Use this minimal configuration:
16+
```lua
17+
-- Paste minimal init.lua or relevant setup here
18+
```
19+
2. Start Neovim with `nvim -u minimal_init.lua`
20+
3. Run the following steps:
21+
- Step 1
22+
- Step 2
23+
- ...
24+
4. See error
25+
26+
**Expected behavior**
27+
A clear and concise description of what you expected to happen.
28+
29+
**Screenshots**
30+
If applicable, add screenshots to help explain your problem.
31+
32+
**Environment (please complete the following information):**
33+
34+
- Neovim Version: [e.g. NVIM v0.9.0]
35+
- OS: [e.g. Ubuntu 22.04]
36+
- markdown-shortcuts.nvim version: [e.g. 0.1.0 or commit hash]
37+
38+
**Additional context**
39+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEAT] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!--
2+
Thank you for contributing! Please make sure to read the CONTRIBUTING.md file first.
3+
-->
4+
5+
**Description**
6+
7+
<!-- Please include a summary of the change and which issue is fixed. -->
8+
<!-- Please also include relevant motivation and context. -->
9+
<!-- List any dependencies that are required for this change. -->
10+
11+
Fixes # (issue)
12+
13+
**Type of change**
14+
15+
<!-- Please delete options that are not relevant. -->
16+
17+
- [ ] Bug fix (non-breaking change which fixes an issue)
18+
- [ ] New feature (non-breaking change which adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
20+
- [ ] This change requires a documentation update
21+
- [ ] Refactoring/Code cleanup
22+
- [ ] Other (please describe):
23+
24+
**Checklist:**
25+
26+
- [ ] My code follows the style guidelines of this project
27+
- [ ] I have performed a self-review of my own code
28+
- [ ] I have commented my code, particularly in hard-to-understand areas
29+
- [ ] I have made corresponding changes to the documentation
30+
- [ ] My changes generate no new warnings
31+
- [ ] I have added tests that prove my fix is effective or that my feature works
32+
- [ ] New and existing unit tests pass locally with my changes
33+
- [ ] Any dependent changes have been merged and published in downstream modules

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2626
- Initial release of `markdown-shortcuts.nvim`.
2727
- Features include: inserting headers, code blocks, bold/italic text, links, tables, checkboxes; toggling checkboxes; creating files from templates; list continuation; configurable keymaps and commands; optional buffer settings.
2828

29-
[Unreleased]: https://github.com/your-username/markdown-shortcuts.nvim/compare/v0.1.0...HEAD
30-
[0.1.0]: https://github.com/your-username/markdown-shortcuts.nvim/releases/tag/v0.1.0
29+
[Unreleased]: https://github.com/magnusriga/markdown-shortcuts.nvim/compare/v0.1.0...HEAD
30+
[0.1.0]: https://github.com/magnusriga/markdown-shortcuts.nvim/releases/tag/v0.1.0

‎CONTRIBUTING.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing to markdown-shortcuts.nvim
2+
3+
Thank you for considering contributing to `markdown-shortcuts.nvim`! We appreciate your time and effort.
4+
5+
## How Can I Contribute?
6+
7+
### Reporting Bugs
8+
9+
- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/magnusriga/markdown-shortcuts.nvim/issues).
10+
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/magnusriga/markdown-shortcuts.nvim/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
11+
- Use the "Bug Report" template if available.
12+
13+
### Suggesting Enhancements
14+
15+
- Open a new issue to discuss your enhancement suggestion. Please provide a clear description of the enhancement and its potential benefits.
16+
- Use the "Feature Request" template if available.
17+
18+
### Pull Requests
19+
20+
- Fork the repository and create your branch from `main`.
21+
- If you've added code that should be tested, add tests.
22+
- Ensure your code lints (if linting is set up).
23+
- Issue that pull request!
24+
25+
## Styleguides
26+
27+
Please try to follow the coding style of the existing codebase. If linters/formatters are configured (e.g., Stylua, Luacheck), please adhere to their rules.
28+
29+
## License
30+
31+
By contributing, you agree that your contributions will be licensed under the MIT License.

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!-- Badges (replace with actual badges) -->
44

55
[![Lua](https://img.shields.io/badge/Lua-blue.svg?style=flat-square&logo=lua)](https://www.lua.org)
6-
[![License](https://img.shields.io/github/license/your-username/markdown-shortcuts.nvim?style=flat-square)](LICENSE)
6+
[![License](https://img.shields.io/github/license/magnusriga/markdown-shortcuts.nvim?style=flat-square)](LICENSE)
77

88
> Enhancing your Markdown editing experience in Neovim with intuitive shortcuts and commands.
99
@@ -33,7 +33,7 @@ Use your favorite plugin manager.
3333

3434
```lua
3535
{
36-
'your-username/markdown-shortcuts.nvim',
36+
'magnusriga/markdown-shortcuts.nvim',
3737
-- Optional dependencies for picker:
3838
-- dependencies = { 'nvim-telescope/telescope.nvim' },
3939
-- dependencies = { 'junegunn/fzf', 'junegunn/fzf.vim' },
@@ -53,7 +53,7 @@ Use your favorite plugin manager.
5353

5454
```lua
5555
use {
56-
'your-username/markdown-shortcuts.nvim',
56+
'magnusriga/markdown-shortcuts.nvim',
5757
-- Optional dependencies:
5858
-- requires = { 'nvim-telescope/telescope.nvim' },
5959
-- requires = { 'junegunn/fzf', run = ':call fzf#install()' },

0 commit comments

Comments
 (0)