CONTRIBUTING.md

Contributing to Leaderboards.gg

We appreciate your help!

Before filing an issue

If you are unsure whether you have found a bug, please consider asking in our discord first.

Similarly, if you have a question about a potential feature, the discord can be a fantastic resource for first comments.

Filing issues

Filing issues is as simple as going to the issue tracker, and adding an issue using one of the templates as listed below:

• Bug Report: Create a report to help us improve
• Feature Request: Suggest an idea to add support for this project
• Suggest a task: Suggest an idea for improving this project without changing functionality

Contributing code

Example code contribution flow

1. Make a fork of this repo.
2. Check out a new branch (refer to Git below for the naming style guide).
3. Commit your changes (Please read our Style guide to help the pull request process go smoothly).
4. Verify your changes work.
5. Push your branch.
6. Open a pull request to leaderboardsgg/infosite.
7. Get your pull request approved.
8. Get someone to click Rebase and merge.
9. Celebrate your amazing changes! 🎉

Style guide

General

• Be inclusive, this is a project for everyone.
• Be descriptive, it can be hard to understand abbreviations or short-hand.
• Make sure that your components are responsive.

Nuxt/Vue

• Comments should be full sentences, starting with a capital letter and ending with punctuation.
• Comments above a function should start with the name of the thing being described.
• Make sure any data and prop names are as descriptive as possible.
• Try to move any repetitive elements into child components to reduce clutter in parent components.
• Use async await for any asynchronous functions.
• Include proper error handling for any async functions.
• Make all components compatible with server side rendering when possible.

Git

• Do not make pull requests from main.
• Do not include slashes in your branch name.
  • Nested paths can act strange when other people start looking at your branch.
• Try to keep commit line length below 80 characters.
• All commit titles should be of the format {area} {optional sub-area}: commit description.
  • This will help people reading through commits quickly find the relevant ones.
  • Some examples might include:
    • profile header: add support for badges
    • leaderboard: adjusted sidebar spacing
• Commits should be as atomic as possible.