Skip to content

Latest commit

 

History

History
58 lines (43 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

58 lines (43 loc) · 2.59 KB
Raw

Contributing to this repository

We Develop with Github

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Report bugs using Github's issues

We use GitHub issues to track bugs. Report a bug by opening a new issue.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or what you have tried that didn't work)

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Create a pull request!

Working in this repository

Packages shipped by this repository

These are the packages that are shipped from this repository:

  1. JsBind.Net
  2. JsBind.Net.Extensions.DependencyInjection

JsBind.Net

This package contains the infrastructure code needed to create a JavaScript binding and handles all the JS interop calls. JavaScript files are also included as part of the package to handle calls from .Net.

Conversion of references between .Net and JS

From .Net to JavaScript

During serialization in .Net, JSON converters are used to write references. In JavaScript, revivers are used to read the references into JavaScript objects.

From JavaScript to .Net Before serialization in JavaScript, ObjectBindingHandler manipulates the objects to be serialized. In .Net, JSON converters are used to read references into .Net objects.

JsBind.Net.Extensions.DependencyInjection

This package provides the service registration in the Microsoft dependency injection container.

Use a Consistent Coding Style

  • 4 spaces (C#) or 2 spaces (XML/JSON/JS) for indentation rather than tabs.
  • Every if, else, for, foreach, while etc should have its own opening and closing bracket, even if it is a single line statement.
  • Every code file changed should be formatted properly (CTRL+K, CTRL+D in VS or ALT+SHIFT+F in VS Code).

License

By contributing, you agree that your contributions will be licensed under its MIT License.