Contributing link in readme

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

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
git, github
Domain
documentation

Research direction

Check the README link to CONTRIBUTING.md and compare its branch target with the repository's current default branch. Update the link so it resolves to CONTRIBUTING.md on main, then verify the URL opens successfully on GitHub.

Written by the indexing model from the issue text.

Description

I had a question that I would like to ask, but when I clicked the link in the readme (https://github.com/wsvincent/lithium/blob/master/CONTRIBUTING.md) on github, it was not found.

If I wanted to get involved with the project, say to do something like fix the CONTRIBUTING.md link, which needs to have master changed to main, which I could easily put up a pull request. Should I do so?

The question I had, was once someone has used your starter app, how can one keep up to date? Do you have any recommendations for this, such as to use a git sub-module?

thanks
dave (tayloredwebsites)

Dominant language
Python
Stars
2.5k
Forks
448
No merged PRs in 30d

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.

More from wsvincent/lithium

All issues in wsvincent/lithium

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.