icipe-official / icipe-official/vectoratlas-software-code
Include citation guidelines
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 8
- Avg merge
- 5d 4h
- Merged PRs (30d)
- 11
Description
Following the typical use case of our application, it is a certainty that images/data will be used in papers and so will require methods by which to cite them. The citation itself will likely require input from Marianne, but the structure of the section and links to it are our focus for this story.
You should include a section detailing what our citation should be. This may be best located in the about section or the help site. You should discuss the options prior to start. Furthermore, links to this section should be easily accessible from locations where the data/images are being extracted or used. This should provide a smoother user experience
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the application's about section, help site, and locations where data or images are extracted or used. Discuss citation options with Marianne before settling the section structure and citation text. Done means a citation-guidelines section exists and links to it are accessible from relevant data and image workflows.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100