Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (30 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 1.73 KB

CONTRIBUTING TO SCROT DEVELOPMENT

Changes are to be sent as pull requests on GitHub.

Setting up the development machine

scrot aims to build with no modifications on all the free unix systems. The master branch is also kept in working order at all times.

You will want to install the dependencies listed in the Building section of README.md. Look for the text install_script in the .cirrus.yml CI definitions for example package manager invocations on many operating systems.

Style

scrot is primarily written in C99 with POSIX 2008 extensions. You're also free to make use of any documented function from our libraries. Make sure to use libbsd functions where they're safer, cleaner or more convenient.

scrot follows WebKit's code style guidelines with additional restrictions:

  • No explicit casts.
  • Use the identifier and not the type as the argument to the sizeof operator.

When in doubt, make use of the clang-format source code formatter-it comes with the WebKit style by default.

Low-hanging fruit

Ongoing tasks will be written to TODO.md.

Easy tasks which can be solved by newcomers are tagged with good first issue. Issues tagged with help wanted are intermediate/difficult issues where we require help.

Regular contributors can ask to join the scrot project on GitHub.