Thanks for considering contributing to Mkdnflow!
To submit a bug report, use the bug report issue template and follow the instructions within the template.
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps.
Suggestions are welcome, including completely new features or minor improvements to existing functionality.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps.
Pull requests are welcome for both bugfixes and new features. I reserve the right not to merge a PR in any case. In all such cases, I will communicate with you on the PR to let you know whether/what changes need to be made to the PR before it can be merged.
- Clearly describe what the pull request does
- Include screenshots or animated GIFs in your pull request when sensible.
- Use Conventional Commits! Otherwise, I will ask you to revise your PR.
- When a PR adds or changes a feature, update the documentation as well.
This project now uses the Conventional Commits specification for its commit messages. This provides a number of benefits, including better human and machine readability and compliance with the requirements for automatic versioning, which is used in the main branch.
In addition to using conventional commits, please adhere to the following when writing commit messages:
- Use the present tense in the imperative mood ("Add feature", not "Added feature" or "Adds feature")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
Examples:
feat: Add new mapping for buffer navigation
fix: Resolve issue with autocmd not firing
docs: Update installation instructions in README
refactor: Simplify autocommand setup