Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 4.57 KB

CONTRIBUTING.MD

File metadata and controls

83 lines (62 loc) · 4.57 KB
Raw

Contributing to camperbot

🔥🎊 Thank you for taking the time to contribute! Any contribution is highly appreciated and welcome. ⛺️

These are mostly guidelines, not rules. It is aimed for beginner to veteran developers. Use your best judgment, and feel free to propose changes to this document in a pull request.

This document takes inspiration from Atom's Contribution Guide. For parts that are still in progress, feel free to reference to them.

This repo aims to be as friendly to new/budding developers, so if there is anything you would like to discuss with us about contributing, feel free to message the admins here: https://discord.gg/WZB4AuS ✨

How to Contribute

There are different ways for you to contribute, even if it's not via code! Look out for labels like first-timer-only or good-first-issue in our issues if you're not sure what to do.

To contribute, you can:

Report Bugs 🐛

If the bot has an odd behaviour, feel free to tell us!

  1. Check if the issue exists first: https://github.com/sirMerr/camperbot/issues
  2. If it doesn't, open a new bug issue! Follow the template.

Suggest Enhancements 🎉

If you feel like the bot is missing something, let us know.

  1. Check if the issue exists first: https://github.com/sirMerr/camperbot/issues
  2. If it doesn't, open a new feature issue! Follow the template.

Add documentation 📝

Documentation is incredibly important, and is needed everywhere. Be it the markdown files (this one for example) or code documentation, we always need help in this department, especially in early development. Simply make a pull request with the file(s) you are helping to fix and you will be prompted with a template you can fill.

There are a few ways to make a pull request. If you just want to change a single file with a small documentation change or markdown file, it's suggested to click on the pencil icon next to the file in GitHub.

Contribute Code ✨

If it's a small one file change, feel free to follow the same instructions mentioned above. Otherwise you can

  1. Fork this repository
  2. Make your changes to the fork
  3. Open a Pull Request
  4. Fill in the template (no need to delete the comments (<!-- -->)
  5. Submit the PR
  6. Wait for Review!

Styleguides

git Branches

Your branch name should try to start with one of the following (other alternatives possible) followed by the main feature you're working on:

  • feature/ for when you are adding a new feature
  • fix/ for when you are making a fix for a bug
  • optimize/ for when you are not inherently changing the behaviour of something, but are still making it better

Example: feature/avatars, fix/docs-typo

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 50 characters or less (not including emojis!)
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable emoji:
    • ✨ :sparkles: when adding a new feature
    • 🔨 :hammer: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 🔧 :wrench:when updating configuration files

JavaScript Styleguide

All code adheres to prettier standards with two differences, found in our .prettierrc:

{
	"trailingComma": "es5",
	"singleQuote": true
}

You can configre your text editor/IDE to show warnings and errors when you do not follow these standards if you would like. However, when you make a commit, a prehook will automatically lint staged filed, so there is no real need to worry about styling unless you want to keep yourself to that standard on your own.