jlab-sensing/ENTS-node-firmware

Add GitHub citation file

Open

#132 opened on Sep 6, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C (7 forks)auto 404
documentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the Enhancement Investigate and implement a citation file for the repo that references the first paper in the project. Instructions from GitHub are available here: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

Benefits Make the repository easier to cite and create a clear connection between published work and code repository.

Possible Drawbacks N/A

Additional Context Most likely will wait until first full length paper is published.

Contributor guide

Research direction
Follow GitHub's instructions to create a CITATION.cff file that references the first paper of the project.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90