MapColonies / MapColonies/ts-server-boilerplate

README: updating release please manifest

Open Beginner friendly
#329 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
1
Forks
1
Avg merge
12h 1m
Merged PRs (30d)
2

Description

There should be a warning in the `README` that when updating existing services to the current boilerplate there is a need to edit the `.release-please-manifest.json` with the repo's current version.
In addition, there should be an example for the file's content.

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.

Research direction

Start in the README section covering updates to existing services and review the `.release-please-manifest.json` format. Add a warning that the manifest must be updated with the repository's current version, plus an example of the file content. Done means both the warning and example are clear and accurate.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.