OurTechCommunity / OurTechCommunity/catchup

Refactor Twitter & Telegram Action name & description.

Open
#172 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

CI/CD good first issue
Dominant language
JavaScript
Stars
19
Forks
18
Avg merge
3d 6h
Merged PRs (30d)
3

Description

The new Twitter and Telegram workflow merged in 0d544594be01a11fc3f592a70e84c7222e97f48d can have a better name and description.


Current name:

https://github.com/OurTechCommunity/catchup/blob/0d544594be01a11fc3f592a70e84c7222e97f48d/.github/workflows/send-messages.yaml#L1

UI on GitHub:

image

This can be changed to 'Send Tweets and Telegram messages'.


Current description:

https://github.com/OurTechCommunity/catchup/blob/0d544594be01a11fc3f592a70e84c7222e97f48d/.github/workflows/send-messages.yaml#L20-L24

This description renders like this:

image

The way GitHub renders the workflow description makes it confusing to read, so a more complete and free-flowing description would be better.

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

Open .github/workflows/send-messages.yaml and inspect the workflow name near line 1 and description around lines 20–24. Compare the current GitHub Actions rendering with the issue screenshots, then update the wording to make the Twitter and Telegram purpose clear. Done means the workflow displays the requested name and a more readable description.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Refactor
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.