- Goal
- Structure
- Naming Conventions
- CODEOWNERS
- Semantic Versioning
- RFCs
- Licensing
- Contributing
- Code of Conduct
- Social Contract
The webview organisation is dedicated to the problem that is using a Web Stack as a application GUI. We are the maintainers of full-stack solutions, core implementations, binding libraries, and other supplements to projects that take this approach. It's our objective to share knowledge and empower each other's pursuits.
There are five main code components of the webview organization:
- core
- bindings
- supplements
- documentation
- testing
Core consists of the main webview repository which provides the backbone for all the language specific bindings, and eventually each language binding should depend on it for providing similar underlying behavior.
webview
- the core headersdocs
- the documentation for the core library (structure to be determined)rfcs
- the RFC librarywebview_testing
- a testing harness for all deviceswebview_actions
- common actions for repositorieswebview_%language%
- a binding to the core headers, where%language%
isnim
,rust
,python
etc.webview_%supplement%
- a supplement to webview, where%supplement%
istray
,notifications
etc.
Every repository in this organization is required to have at minimum two code owners.
All repositories are required to strictly follow Semantic Versioning 2.0..
Additions or modifications to the core that are likely to have changes "trickle down" to bindings and consumers deserve special attention.
All repositories are required to maintain license files and a notice in the readme, as well as placing it in appropriate packaging files such as but not limited to a package.json
or Cargo.toml
. Please follow the dual licensing model of MIT and Apache 2.0.
We consider all types of contributions to be important additions to this organization. Filing issues, maintaining bindings, reviewing pull-requests and participating in discussions are all activities that we expect to follow the rules set out in the following code of conduct.
Please take a moment review our Code of Conduct. Your participation in this community requires that you follow these rules.
In addition to the Code of Conduct, we also abide with a Social Contract as regards this project and our community. Please take a moment to review it.
2020 (c) The Webview Contributors This document is licensed under CC-BY-INTL 2.0.