File: CONTRIBUTING.md

package info (click to toggle)
fswatch 1.14.0+repack-13
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 1,460 kB
  • sloc: cpp: 4,557; makefile: 184; sed: 16
file content (28 lines) | stat: -rw-r--r-- 895 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Contributing to fswatch
=======================

The easiest ways to contribute to `fswatch` are:

  * Creating a new [issue].
  * Forking the repository, make your contribution and submit a pull request.
    See [GitHub Flow](#github-flow) for further information.

[issue]: https://github.com/emcrisostomo/fswatch/issues/new

Github Flow
-----------

I chose to use the [Github flow][flow] for `fswatch`, so you are
kindly required to follow the same model when making your contributions.

[flow]: https://help.github.com/articles/github-flow/

Coding Conventions and Style
----------------------------

The C and C++ code uses `snake_case` and is formatted with a customized
[Allman (BSD)][allman] style.  See [`README.codestyle`][codestyle] for further 
information on how setting up your IDE.

[codestyle]: README.codestyle
[allman]: https://en.wikipedia.org/wiki/Indent_style#Allman_style