Add link to contributing guide in README

Open Beginner friendly
#285 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
70/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Open the repository README and locate its bottom section, then find the contributing guide referenced by the project. Add a visible link to that guide at the bottom of the README and confirm that the link resolves for newcomers.

Written by the indexing model from the issue text.

Description

documentation good first issue

When we make a project with a README-only (no sphinx docs), it's not necessarily obvious to newcomers where the contributing guide is. We should probably just add a link at the bottom of the README.

Dominant language
Jinja
Stars
25
Forks
10
Avg merge
4h 4m
Merged PRs (30d)
6

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 DiamondLightSource/python-copier-template

All issues in DiamondLightSource/python-copier-template

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.