diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..6db92856 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Glide // Styled's Vehicle Base + +Thank you for your interest in helping out. I'd like to mention a few things to check when you open a pull request: + +- When you create a fork, make your changes in a separate branch. (Don't use `main`) +- If you know about bugs in your code, please mention them in the pull request. +- Your code can be a work-in-progress if you want others to help or need opinions, just make sure to mention that in the pull request. +- Follow the [CFC style guidelines](https://github.com/CFC-Servers/cfc_glua_style_guidelines). Optionally you can also install [glualint](https://github.com/FPtje/GLuaFixer) and it's extension to get warnings on your preferred text editor. \ No newline at end of file diff --git a/README.md b/README.md index 91c271ac..0934c438 100644 --- a/README.md +++ b/README.md @@ -138,4 +138,4 @@ A pack of content and entity classes to add cars, motorcycles, planes, helicopte ## Contributing -Please follow the [these rules](https://github.com/StyledStrike/gmod-glide/blob/main/.github/pull_request_template.md) before opening pull requests. +Please follow the [these rules](CONTRIBUTING.md) before opening pull requests.