How to contribute to GunPlus

Did you find a bug?

Do not open up a GitHub issue if the bug is a security vulnerability in Gun, instead to refer to the gun security policy.
Ensure the bug was not already reported by searching on GitHub under Issues.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behaviour that is not occurring.

Did you write a patch that fixes a bug?

Open a new GitHub pull request with the patch.
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
Before submitting, please read this document in its entirety.

Do you intend to add a new feature or change an existing one?

Suggest your change in the gun community forum and start writing code.
Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about the source code?

Ask any question about how to use GunPlus by making a mention to @gustavcorpas.

Do you want to contribute to the GunPlus documentation?

I write GunPlus in my spare time. I encourage you to pitch in.

Thanks! ❤️ ❤️ ❤️

Styleguide

The code in the repo uses the following style:

Use PascalCase for class names: example: class MyClass

The first letter of every word is capitalized.
There are no spaces between words.

Use snake_case for variable- and function names and function parameters example: function my_function(my_parameter){}

Words are separated by underscores.
All letters are in lowercase.