Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create CONTRIBUTING.md #442

Open
unrealapex opened this issue May 2, 2024 · 1 comment
Open

Create CONTRIBUTING.md #442

unrealapex opened this issue May 2, 2024 · 1 comment

Comments

@unrealapex
Copy link
Contributor

unrealapex commented May 2, 2024 •
edited

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

Adding these to a CONTRIBUTING.md would making contributing to this project more streamlined.
@OkelleyDevelopment
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@OkelleyDevelopment @unrealapex