Make first-time fork and pull-request contribution instructions accurate

Open Beginner friendly
  • Is something wrong?
#51 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript, markdown, nodejs
Domain
developer-experience, documentation

Research direction

Read CONTRIBUTING.md, README.md, docs/PROJECT_CONTEXT.md, and AGENTS.md to check the current contribution guidance and package scripts. Update the fork-to-PR instructions and linked issue queries to match the acceptance criteria, including offline checks that need no Moodle access. Confirm links resolve, run the documented offline checks and npm run check, then run git diff --check and report checks not run.

Written by the indexing model from the issue text.

Description

area:docs good first issue help wanted priority:medium type:chore

Part of #28 · Target: Contributor readiness / v1

Goal and scope

Update template instructions to actual master default branch and fork-based contributions. Explain choosing/commenting on an issue, dependencies, branch naming, synthetic offline tests, PR checks and review. Link help wanted/good first issue queries and v1 tracker.

Implementation starting points

CONTRIBUTING.md, README.md, docs/PROJECT_CONTEXT.md. Follow AGENTS.md and docs/PROJECT_CONTEXT.md; reuse existing authorization, safe-error and synthetic-fixture patterns. New runtime dependencies need a documented reason.

Dependencies and readiness

Ready to discuss/start independently against current master.

Out of scope

No requiring collaborator write access, real credentials or copying private faculty data into fixtures; do not assign volunteers without consent.

Acceptance criteria and test plan

A newcomer can follow documented fork→branch→offline checks→PR flow without Moodle access. Commands match package scripts, links resolve and no personal paths/secrets appear. Documentation-only validation and existing CI are sufficient.

Run the relevant offline tests, npm run check and git diff --check; runtime changes also require npm test and npm audit. Report checks not run. No faculty credentials or private course material are required for a contribution.

Contributing

Comment here before starting so the maintainer can coordinate the approach and avoid duplicate work. Fork the repository, branch from master, and open a focused PR referencing this issue. No assignee or delivery deadline is set; required checks and review apply.

Dominant language
JavaScript
Stars
0
Forks
0
Avg merge
1h 20m
Merged PRs (30d)
14

Getting set up

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.

More from mahmutmft/courses-mcp

All issues in mahmutmft/courses-mcp

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.