handsontable / handsontable/hyperformula
[GUIDE] How to create a new formula for HyperFormula engine
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.8k
- Forks
- 171
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 7
Description
Description
For the contributors that would want to help finish the long "missing formulas" list.
Brainstorming:
- How a formula is build
- How they are grouped, which file should it be added to
- Where tests are located and how they are organized
- Checklist for completeness:
- formula
- tests
- translations
- meta data
- Where to find the spec (Open Document Format Formula spec)
- How to deal with incompatibilities with other spreadsheets if any
- CLA requirement
- Where to find the missing formulas list
Links
Might be a part of the readme https://github.com/handsontable/hyperformula/issues/8 "contributing" section.
Location for formulas, they are stored and grouped as plugins https://github.com/handsontable/hyperformula/tree/master/src/interpreter/plugin
This issue was transferred, the original author: @wojciechczerniak
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the contributing section referenced in issue #8 and the formula plugins under src/interpreter/plugin. Map the existing formula, test, translation, metadata, specification, incompatibility, CLA, and missing-formula resources, then document where each belongs and how a contributor can verify a new formula is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100