leanprover-community / leanprover-community/physlib

API: Higgs Field

Open
#857 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API help-wanted requirements-needed
Dominant language
Lean
Stars
749
Forks
189
Avg merge
1d 21h
Merged PRs (30d)
75

Description

The details of this issue are not yet completed. The issue is here to track the progress of the API specified by the title. Parts of this API may already be included within the project. There are a number of things we need to specify, help in specifying these points is appreciated.

Key data structure

What is the key data structure the API is built around.

Need

Why is this API needed, after it is completed, what will it make easier or allow us to do.

Requirements

A tickbox list of the requirements of the API. This should include things which have already been done as well as things still to be worked on.

Corresponding file system

If it exists, the part of the PhysLean which corresponds to this API.
.

Parent APIs

#856

Contributor guide

Open the contributing guide

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.

Research direction

Start by reading issue #856 and the existing PhysLean project structure, since this issue does not identify a corresponding file or entry point. Define the Higgs Field API's key data structure, purpose, requirements, and filesystem location, recording which requirements already exist and which remain.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.