Contributing

Contributing to this project

⮜ Tutorial: Creating a plugin | ⮨ Back to the Index | ➤ Links / References

Feel free to contribute to this project! We are always welcome to new ideas, bug fixes, and features.

However, make sure to take a look at our code of conduct before submitting any pull requests. Our coding guidelines are:

• Allman style. End of discussion. Linux kernel / K&R bois can get the hell out.

• You are encouraged to omit { and } around single-lined blocks^[1], e.g.:

  if (true)
      func();
  
  do
      func();
  while (true);

  But do not write any of this crap:

  if (true) func();
  
  do func(); while (true);

  Do not write any of that shite either:

  if (true) { func(); }
  
  do { func(); } while (true);

• PascalCase for types, methods, properties, public identifiers, etc.

• underscore_lower_case for method parameters and local variables

• _underscore_lower_case for private fields

• CAPS_LOCK_CASE for constants

• Try to avoid using external libraries or packages as much as possible. There are already enough dependencies in this project.

To avoid any association with slavery, the master-branch has been renamed to daddy 😉.

[1]: If you are whining about the problems induced by optional braces then go get yourself an IDE and stop using simple text editors.