Skip to content
This repository has been archived by the owner on Nov 28, 2022. It is now read-only.

Latest commit

 

History

History
86 lines (63 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

86 lines (63 loc) · 3.07 KB
Raw

Contributing to Hawthorne

First of, thank you for taking the time out of your busy schedule to help this project out. In this document, you will find all the information necessary to successfully contribute to the project.

This CONTRIBUTING.md is adapted from the atom project.

Table Of Contents

Styleguides

How Can I Contribute?

How Can I Contribute?

You can contribute in several ways. Even for non tech savy people, there's a lot to do.

Reporting Bugs

When you have discovered a bug, please do not simply complain - but rather give the developer information to reproduce the problem. This can be done by providing:

  • Screenshots
  • hawthorne report
  • Retrieving the last 100 lines of /var/log/hawthorne/debug.log

You can submit the bug either as an issue in the GitHub (I will probably not forget about it then - or post it in the Discord.)

Suggesting Enhancements

Enhancements are one of the most important things for this project. To get a good idea of what you want, please write a detailed description of your suggestion. Please make sure your idea is not already on the project roadmap or has not already been suggested by another user.

You can submit the suggestion either as an issue in the GitHub (I will probably not forget about it then - or post it in the Discord.)

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the Python and SourcePawn styleguides.
  • End all files with a newline
  • Avoid platform-dependent code

Styleguides

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

Python Styleguide

All Python code must be valid against PEP-8, modifications done by the author of the projects are:

  • 2 tabspace intend, instead of 4 tabspace intend
  • 90-ish characters per line or less

SourcePawn Styleguide

SourcePawn has no global styleguide so these are the one in the project used - this is a rough adaptation of PEP-8.

  • 2 tabspace intend

  • 90-ish characters per line or less

  • { and } never on a line alone

    Valid:

        if () {

    } else {

    }

    Invalid:

        if ()
    {

    }
    else
    {

    }

  • Functions are in CamelCase

  • Variables are in snake_case

  • Variable and function names need to be short and expressive. Variablename a is not valid, state is valid

  • Global variables that permanent for a server or user lifetime are UPPERCASE