Convention for references

Open
#124 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start by locating the repository's contribution guidelines; the issue does not name a file or specify which reference convention is wanted. Clarify the expected convention with the maintainers before editing, then update the guidelines once the scope and completion criteria are agreed.

Written by the indexing model from the issue text.

Description

documentation enhancement

Could you include a convention for references in your contribution guidelines?

Dominant language
Python
Stars
3
Forks
2
Avg merge
3d 23h
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 pyfar/gallery

All issues in pyfar/gallery

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.