Add CONTRIBUTING.md (#819)

1 files changed, 48 insertions, 0 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..cf6bbb96
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,48 @@
+# Contributing to LunarVim
+
+Welcome to the LunarVim contributing guide. We are excited about the prospect of you joining our [community](https://github.com/ChristianChiarulli/LunarVim/graphs/contributors)!
+
+There are many opportunities to contributing to the project at any level. Every contribution is highly valued and no contribution is too small.
+
+You do not need to write code to contribute to this project. Documentation, demos, and feature design advancements are a key part of this project's growth.
+
+One of the best ways to begin contributing in a meaningful way is by helping find bugs and filing issues for them.
+
+## Getting Started
+
+1. Backup your ~/.config/nvim
+2. Follow the [Installation](https://github.com/ChristianChiarulli/LunarVim/wiki/Installation) guide
+3. Link your fork with the repository `git remote add upstream https://github.com/ChristianChiarulli/LunarVim.git`
+4. That's it ! You can now `git fetch upstream` and `git rebase [-i] upstream/rolling` to update your branches with the latest contributions.
+
+## Setting up development tools
+
+1. Install [stylua](https://github.com/johnnymorganz/stylua#installation)
+2. Copy tools/.stylua.toml into the LunarVim root directory
+
+## Some Guidelines
+
+### Git Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+
+### Git Branch Naming
+
+* Name your branches meaningfully,
+ex: (feature|bugfix|hotfix)/what-my-pr-does
+
+### Code 
+
+All lua code is formatted with [Stylua](https://github.com/JohnnyMorganz/StyLua).
+* Use snake_case
+* Avoid platform-dependent code
+
+## Communication
+
+Members of the community have multiple ways to collaborate on the project.
+We encourage you to join the community:
+- [Discord server](https://discord.gg/Xb9B4Ny)
+- [Matrix server](https://matrix.to/#/+atmachine:matrix)