Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 1.31 KB
Raw

How to contribute

Hi there and thank you for your interest in contributing to pause-on-lock! You rock!

Ways of contributing

There are three major ways of contributing:

  1. Reporting bugs
  2. Introducing new ideas
  3. Enhancing the code

Reporting Bugs

If you found a bug in pause-on-lock, please open an issue so that we can investigate and remove it.

Introducing new ideas

If you have an idea how pause-on-lock can be improved (this can range from supporting an additional desktop environment to whatever your mind comes up with) please also open an issue and tell us about your idea.

Enhancing the code

If you want to add a new feature or revise the existing code, feel free to submit a pull request. However, to make sure that you don't waste your time please also consider opening an issue for discussion beforehand.

Coding Guidelines

The two basic rules for the coding style are:

  • Use 2 spaces for indentation
  • Limit line length to 80 characters (may be exceeded for e.g. long strings)

Other than that, try to make shellcheck happy.

Thanks again for contributing!