Welcome to the flatten.nvim contributing guide

Issues and Pull Requests

Did you find a bug?

Check if the bug has already been reported to issues
Please submit an issue if one does not already exist.
- If you're open to contributing a fix, please note that in your issue post.
- If possible, use the relevant bug report template to create the issue.

Did you write a patch that fixes a bug?

Open a new PR with the patch.
Link a relevant issue if possible.
Please ensure your PR description clearly describes the number and solution.

Did you write a patch that adds documentation?

Please ensure your documentation passes checks by grammarly or a similar checker.
Ensure your documentation does not contain any emojis or special characters that may not render properly on all devices.
Submit a PR!

Are you looking to add a new feature?

Create an issue with the enhancement label or feature request template, to gauge interest in your feature.
Once you've determined there's enough interest for your feature, make a PR and link your issue.

Do you have questions about the source code?

Use the discussions section so that replies/answers will be easily visible for people in the future.

Code style

Commit messages should use the conventional commits format
- PRs that contain commits not using the conventional commits format will be rejected until their messages are amended.
Commit messages should not contain emojis.
Commits should be formatted correctly (use stylua, or just ensure that your formatting matches the rest of the repo)

Thanks! ❤️

Willothy