CONTRIBUTING.md

Contributing to dzcode.io

Contributions are always welcome. Before contributing please read the code of conduct & search the issue tracker; your issue may have already been discussed or fixed in main. To contribute, fork dzcode.io, commit your changes, & send a pull request.

Do you have a suggestion?

Feature requests should be submitted in the issue tracker, with a description of the expected behavior & use case. Before submitting a request, please search for similar ones in the closed issues.

Did you find a bug?

When logging a bug, please be sure to answer the following:

• A clear and concise description of what the bug is
• If at all possible, an isolated way to reproduce the behavior
• The behavior you expect to see, and the actual behavior

Do you have a question?

The issue tracker is for issues, in other words, bugs and suggestions. If you have a question, please contact us via EMail or any of our social links.

Coding Guidelines

In addition to the following guidelines, please follow the conventions already established in the code.

• Spacing:
  Use two spaces for indentation. No tabs.

• Naming:
  Keep variable & method names concise & descriptive.
  Variable names index, array, & iteratee are preferable to i, arr, & fn.

• Quotes:
  Double-quoted strings are chosen over single-quoted strings; to avoid unnecessary escaping.

• Comments:
  Please use single-line comments to annotate significant additions, & JSDoc-style comments for functions.

Guidelines are following the .editorconfig file.