dotnet-foundation / dotnet-foundation/projects

Jot

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

@clairernovotny is already working on this.

Since Aug 20, 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: Jot

License: MIT

Contributor (Company, Organization or individual name(s)): Antonio Nakic-Alfirevic (Windy Range Software d.o.o.)

Existing OSS Project? (Yes/No): Yes

Source Code URL: https://github.com/anakic/Jot

Project Homepage URL (if different):

Project Transfer Signatories: Antonio Nakic-Alfirevic (antonio.nakic@gmail.com)
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).

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:

Jot is a library for tracking application state. Typically this includes window sizes and locations, last entered data, application settings, and user preferences. In short: a better alternative to using settings files.

A common approach is to store this data in a .settings file and read and update it as needed. This involves a lot of boilerplate code to copy that data back and forth. This code is generally tedious, error-prone and no fun to write.

With Jot, you only need to declare which properties of which objects you want to track, and when to persist and apply data. This is a better abstraction for this common requirement, resulting in more readable and concise code.

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

Jot is a library for tracking application state, e.g. window sizes and locations, application settings, and user preferences.

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: Antonio Nakic-Alfirevic
Email: antonio.nakic@gmail.com
GitHub Profile URL: https://github.com/anakic

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)

Antonio Nakic-Alfirevic (@anakic)

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.

  • An issue is created describing the proposed code change.
  • After a review/design process, the maintainers of the project accept the proposed change.
  • Change is implemented and submitted as a pull request.
  • Pull request is reviewed and ultimately approved when it aligns with the agreed-upon design and coding/architecture standards of the project.

So far the project has only received sporadic pull requests. New committers would ideally have made substantial contributions via pull requests which would demonstrate their understanding of the internals of the project, after which they could request contributor status via email.

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 Notification Alias
Provide an email address that will receive CLA related notifications from the .NET Foundation CLA automation

antonio.nakic@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

  • 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
  • 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.

No particular PR plan aside from an occasional tweet/article/YouTube video.

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?

The project uses AppVeyor for CI through NuGet packages are (currently) manually created and deployed from a dev machine.

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.

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.