meteor/meteor

Document main function

Open

#12,320 opened on Nov 24, 2022

View on GitHub
 (7 comments) (2 reactions) (0 assignees)JavaScript (44,781 stars) (5,257 forks)batch import
Project:Docsgood first issuehacktoberfestidle

Description

Every Meteor app has to have a main function. For most apps, the webapp package defines it. For apps that do not use the webapp package, they have to define it another way, but it currently isn't documented.

The relevant code is: https://github.com/meteor/meteor/blob/1e2346cd5a31a4044afad4049dd736f518d6ea76/tools/static-assets/server/boot.js#L452-L486

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Meteor
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Read the linked code in boot.js (lines 452-486) to understand the main function and its relationship with the webapp package. Review the issue comments for any clarification on expectations. Then propose documentation updates in the Meteor guide or API docs, focusing on when a custom main is needed and how to define it.
Document main function · meteor/meteor#12320 | Good First Issue