Create CONTRIBUTING.md - Githubissues

rafamadriz / friendly-snippets

Set of preconfigured snippets for different languages.

MIT License

1.91k stars 435 forks source link

Create CONTRIBUTING.md #442

Open unrealapex opened 3 months ago

unrealapex commented 3 months ago

I noticed that there is no documentation regarding a few things:

how to contribute to this project
- expectations
- testing code using the minimal config files in debug/
- Test snippets with the minimal debug config using nvim -u <debug-file>
style guidelines
- what JSON formatter to use
- ensuring commits meet the Conventional Commits specification
links resources on how to create snippets
- VS Code documentation
- Lua snippets
- etc...

Adding these to a CONTRIBUTING.md would making contributing to this project more streamlined.

OkelleyDevelopment commented 3 months ago

Fair point, perhaps this is something @rafamadriz can weigh in on?