Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

74 lines (49 loc) · 3.19 KB
Raw

WIP - will add more if there is demand.


❔ Got a Question or Problem?

Start with as search in friflo/Friflo.Json.Fliox/search and enter the search text in the bar on the top.
Eventually refine the results with Languages > Markdown

If there is no match add a New issue at friflo/Friflo.Json.Fliox/issues


🐛 Found an Issue?

Before creating a New issue check if it is already reported at friflo/Friflo.Json.Fliox/issues.
If yes it is sufficient to comment on this issue.

Issue reproducible with C#

  • Create a Fork of friflo/Fliox.Examples
  • Create a branch will a descriptive name
  • Add the source to reproduce the issue.
  • Use either the Demo or Todo example. Choose the one which fits better.
  • Create a New issue at friflo/Friflo.Json.Fliox/issues and add a link to the forked repository.
  • Name the suspicious classes and methods related to the issue in the description.
  • Describe the error and the expectation.

Issue reproducible with the Hub Explorer


🎨 Want a Feature?

Before creating a New issue check if a similar feature requests is already reported at friflo/Friflo.Json.Fliox/issues.
If yes it is sufficient to comment on this issue.

Otherwise


🧩 Submitting a Pull Request

For this topic I have to state my expectation in context of this project.

It still have to make fun working with Fliox.
This is the backing for reliable maintenance of the project in the future.

My personal experience with Pull Requests is - reviewing is time costly, slow and not really fun.
Also rejecting a Pull Request is not nice for both parties.
I guess I will be reserved to merge a Pull Request.

Because of this mindset Fliox enables adding useful features without the need to modify source of this repository.
These are:

  • New code generators for new programming languages or schema formats.
  • New database adapters for unsupported databases.
  • Adding custom request handlers. E.g. to support Protocol Buffers as an alternative request / response format.

These features can be created in separate repositories without ever leaving a notice.
In case there is demand I would create a new section linking to these projects.

All these contributions are absolutely welcome!

In case a Pull Request is required

  • Create a New issue mentioning you want to create a Pull Request
  • A Pull request in friflo/Friflo.Json.Fliox will require signing a CLA.