pycroscopy / pycroscopy/sidpy

Add links to GitHub how-to in documentation

Open
#77 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue help wanted
Dominant language
Jupyter Notebook
Stars
12
Forks
18
PR merge metrics
No merged PRs in 30d

Description

We already have a fair bit of information in this documentation page. However, this new repo is FAR better. We need to swap out appropriate bits. Thanks to @ziatdinovmax for sharing this.

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 the contribute.html documentation page linked in the issue and compare its contribution guidance with the first-contributions repository. Replace the appropriate parts with links or guidance from that repository, and consider the work done when the page points contributors to the improved GitHub how-to information.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.