Skip to content
This repository has been archived by the owner on Feb 11, 2025. It is now read-only.

Latest commit

 

History

History
22 lines (13 loc) · 1.25 KB

CONTRIB.md

File metadata and controls

22 lines (13 loc) · 1.25 KB

Guidance on how to contribute

There are two primary ways to help:

  • Using the issue tracker, and
  • Changing the code-base.

Using the issue tracker

Use the issue tracker to suggest feature requests, report bugs, and ask questions. This is also a great way to connect with the developers of the project as well as others who are interested in this solution.

Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in the issue that you will take on that effort, then follow the Changing the code-base guidance below.

Changing the code-base

Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull-request. All new code should have associated unit tests that validate implemented features and the presence or lack of defects. Additionally, the code should follow any stylistic and architectural guidelines prescribed by the project. In the absence of such guidelines, mimic the styles and patterns in the existing code-base.

Coding style

  1. Use camelCase naming style.
  2. Don't make methods & variables visible unless it's highly necessary.
  3. Avoid using 3pc libraries for generic functions (collections, string parsing, etc). We don't want to become a hostages of those libraries once.