riseproject-dev / riseproject-dev/python-wheels

Development guide should suggest including links to original workflow files

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

Nobody has claimed this yet.

enhancement good first issue infrastructure
Dominant language
Python
Stars
0
Forks
0
Avg merge
16h 14m
Merged PRs (30d)
952

Description

For reference/comparison purposes, all of our workflows should provide a link to the workflows they're based on in the respective upstream repositories. The best place to make this change is in the docs/development.md file, but a change to the various linting/content checking workflows run against each PR would be good too.

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 with docs/development.md and review the linting and content-checking workflows run against each pull request. Identify the upstream workflow sources for comparison and add links where appropriate. Done means the development guide, and any updated workflows, link to their original upstream files.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.