dotnet-foundation / projects

This repository is used for onboarding new projects
111 stars 30 forks source link

Please consider CavemanTcp as a candidate for a .NET Foundation project #284

Open jchristn opened 1 year ago

jchristn commented 1 year ago

1.   General Information

Project Name: CavemanTcp

License: MIT

Contributor (Company, Organization or individual name(s)): Joel Christner

Existing OSS Project? (Yes/No): Yes

Source Code URL: https://github.com/jchristn/cavemantcp

Project Homepage URL (if different):

Project Transfer Signatories: Full legal name and email address required of the individual(s) with the authority to transfer or contribute the project to the .NET Foundation. Note that if you'd prefer not to include this in the public application, it can be submitted via e-mail to contact@dotnetfoundation.org (referencing this issue number).

Joel Christner, joel.christner@gmail.com

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:

Elegant wrapper for TCP sockets to make building distributed systems and state machines easier.

Please provide a 1 sentence (<140 character) summary of your project to help users when searching the .NET Foundation projects

Elegant wrapper for TCP sockets to make building distributed systems and state machines easier.

3.   Project Governance

Please complete this section about who will be maintaining the open source project and how it will run. Project Lead: (Who is the primary contact point for the community and the .NET Foundation when discussing governance of the project.)

Name: Joel Christner Email: joel.christner@gmail.com GitHub Profile URL: https://github.com/jchristn

Committers:

Which individuals have commit / write access to the repository, what is their GitHub ID and who is their employer (if contributions are on behalf of an employer)

Joel Christner

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.

Proposed via issues, discussions, or pull requests. Inclusion has been solely at my discretion.

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?

No CLA exists.

CLA Notification Alias Provide an email address that will receive CLA related notifications from the .NET Foundation CLA automation

joel.christner@gmail.com

Assignment Model. Under the .NET Foundation assignment model, project ownership and other intellectual property is assigned to the .NET Foundation and the .NET Foundation agrees to grantback a license to the contributor(s).

Contribution Model. Under the .NET Foundation contribution model, a project retains ownership of the copyright, but grants the .NET Foundation a broad license to the project’s code and other intellectual property. The project also confirms that the project’s submissions to .NET Foundation are its own original work (there are also instructions for any third party materials that might be included).

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

5. Eligibility Criteria

Please complete the following for your project

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.

Like many of the libraries I've published, this provides a helpful wrapper that simplifies integration and development. Building distributed systems that use TCP as their transport is hard if you try to roll your own implementation. This library (along with others I own/manage) make that task far, far easier.

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?

Hosting only on Github; could use a certificate if we wanted to sign the package.

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.

I have a host of other libraries that I would love to submit to the foundation. It might be easier to discuss them on a call than it would be to submit a Github issue for each. They are all on Github and available under the MIT license (see WatsonTcp, WatsonWebserver, BlobHelper, SuperSimpleTcp, HttpServerLite, WatsonWebsocket, et al)

sbwalker commented 1 year ago

The Project Committee recently reviewed your application. The Project Committee Charter (https://github.com/dotnet-foundation/projects) contains activity criteria which is used to evaluate project applications. This project does not currently have activity or adoption metrics at a level which would allow for an application approval - however based on the broad applicability, it will be included in the Seed category (https://dnfprojects.org/!/Jun-13-2023/Jul-13-2023/seed/pr) for consideration as a Member project in the future.