f3ve's Contribution Guide

Hey :wave:, thanks for your interest in contributing to one of my projects. I like to keep it simple and reduce the amount of hoops people need to jump through. That being said I do have a couple of rules.

🎨 Code Style

All my NodeJS and JavaScript projects use ESlint and Prettier. I have an eslint-config module that most of my projects will use. In general just make sure you have the ESLint and Prettier plugins for your particular IDE installed and let them autoformat your code and you should be good to go.

🎉 Submitting a Pull Request

Discuss first

Before you start working on a feature please open a feature request issue first to disccuss it with a maintainer. This will save everyone time.

Commits

Please use convential commits for commit messages.

PR Naming

Please give your PR a title that follows convential commits

PR format

Please use the provided PR template for the specific project you are contributing to. Generally they will use this PR template.