dotnet-foundation / dotnet-foundation/projects

Venflow

Open
#134 0 comments 0 reactions 2 assignees View on GitHub

@clairernovotny is already working on this.

Since Feb 1, 2021.

project application
Dominant language
No language data
Stars
157
Forks
37
PR merge metrics
No merged PRs in 30d

Description

1.   General Information

Project Name: Venflow

License: Apache-2.0

Contributor (Company, Organization or individual name(s)): TwentyFourMinutes

Existing OSS Project? (Yes/No): Yes

Source Code URL: https://github.com/TwentyFourMinutes/Venflow

Project Homepage URL (if different): https://twentyfourminutes.github.io/Venflow/

Project Transfer Signatories: Paul Hagspiel - office@twenty-four.dev

2.   Description

Please provide a brief statement about your project in terms that are understandable to the target consumer of the library or project, i.e. an elevator pitch for the project:
Venflow is a brand new ORM, written from the ground up, with performance always in mind, to try and provide an performant alternative to all the great ORMs out there.

Please provide a 1 sentence (<140 character) summary of your project to help users when searching the .NET Foundation projects
Venflow, a brand new, fast and lightweight ORM, build for PostgreSQL.

3.   Project Governance

Please complete this section about who will be maintaining the open source project and how it will run.
Project Lead:

Name: Paul Hagspiel
Email: office@twenty-four.dev
GitHub Profile URL: https://github.com/TwentyFourMinutes/

Governance Model:

Please describe how new code changes are proposed to the project, how those changes are reviewed and how a decision is made to accept proposed changes. Also describe the process for identifying and appointing new committers.

At the current state, I am the only core contributor, which means, that for the time being I just push code. However for non-core contributors, an issue has to be created in which a potential pull request will be discussed. Additionally the repository also provides new committers with a contributing guideline.

CLA

If already an OSS project, was a Contribution License Agreement in place for contributions accepted? How does the project check who has signed one?
The project uses the cla-assistant GH Action, which requires all new contributes to sign the CLA.

CLA Notification Alias
Provide an email address that will receive CLA related notifications from the .NET Foundation CLA automation
office@twenty-four.dev

Project Transfer Type

  • Assignment
  • Contribution

4.   Repository Layout

The .NET Foundation host guidance for new projects and details on recommended structure here:
https://github.com/dotnet/home/tree/master/guidance

Note that the open source repository should be the master where changes are made by the core development team using the same PR process that is used for non-committer contributions.

Please define below any changes you would want to make to your repositories as part of the process of joining the .NET Foundation

The repository is primarily structured into three sections, the GH Pages documentation (/docs), the source code itself (/src) and all the misc items remain in the root directory. Additionally the Code of Conduct and/or the CLA might be adapted to the ones by the .Net Foundation.

5. Eligibility Criteria

Please complete the following for your project

  • The project is built on the .NET platform and/or creates value within the .NET ecosystem.
  • Yes
  • No
  • The project produces source code for distribution to the public at no charge.
  • Yes
  • No
  • The project's code is easily discoverable and publicly accessible (preferably on GitHub).
  • Yes
  • No
  • The project contains a build script that can produce deployable artifacts that are identical to the official deployable artifacts, with the exception of code signing (Exception may be granted for strong name keys, though strongly encouraged to be committed. Exception relies on OSS signing being in the build script for public builds).
  • Yes - No build scripts are required, it can be build through the common dotnet build command.
  • No
  • When applicable, project must use reproducible build settings in its toolchain.
  • Yes
  • No
  • Yes
  • No
  • The project uses either embedded PDBs or publish symbol packages to NuGet (if applicable).
  • Yes
  • No
  • The project code signs their artifacts as appropriate.
  • Yes
  • No
  • The project organization has 2FA enabled. Requiring 2FA must be done as part of onboarding if not already enabled.
  • Yes
  • No
  • Libraries that are mandatory dependencies of the project are offered under a standard, permissive open source license which has been approved by the .NET Foundation (exceptions include a dependency that is required by the target platform where no alternative open source dependency is available such as the .NET Framework or a hardware specific library).
  • Yes
  • No
  • Committers are bound by a Contributor License Agreement (CLA) and/or are willing to embrace the .NET Foundation's CLA when the project becomes a Member.
  • Yes
  • No
  • The copyright ownership of everything that the project produces is clearly defined and documented.
  • Yes
  • No
  • The project has a public issue tracker where the status of any defect can be easily obtained.
  • Yes
  • No
  • The project has a published Security Policy.
  • Yes
  • No
  • The project has a home page which provides high level information about its status and purpose.
  • Yes
  • No
  • The project has a public communication channel where community members can engage with maintainers.
  • Yes
  • No
  • The project has a publicly available location where members can review and contribute to documentation.
  • Yes
  • No

6.   PR Plan

Please summarize the public relations plan for the announcement when joining the foundation (and releasing as open source if appropriate). What is the main story we wish to promote, through what channels, what issues should we be aware of?  For significant news events then please also work with your .NET Foundation contact to ensure a full PR plan is developed.

If the project gets accepted by the foundation, it will be proudly displayed on the README as well as on the projects homepage. Additionally roughly at the same time, the first non-pre-release version will be released. In addition to that, articles on different platforms such as reddit, medium and codeproject will be released regarding to this release. The announcement of the project join to the foundation, if it will, should be aligned with the first non-pre-release version.

7.   Infrastructure Requirements

Please describe any infrastructure requirements for the project. For example, how will build servers be operated? Any web hosting or service hosting requirements? Do we need to set up SSL certificates or provide Authenticode Code Signing arrangement for releases?
No. The Project utilizes GitHub Pages, Actions and Packages for all its needs.

8.   Additional Notes

Please provide any additional information required or use this area for notes during the onboarding process. If this open source project has similarities with any other projects in this space then please detail them and why this project is different. If there are any potential issues that you feel the project might need help with early on then also state them here and discuss with your .NET Foundation Contact.

It is very similar to EF-Core, but competes in a different space. While Venflow is an ORM just like EF-Core, it tries to solves a different issue. Venflow is all about raw SQL and creating the most performance optimized API's for this exact job. Where as EF-Core offers a full fledged all rounder ORM experience, with the options for Linq2Sql and a lot more.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.