cdnjs / cdnjs/packages

Enhancement: Add detailed contributing information for adding a new library

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

Nobody has claimed this yet.

📖 Documentation hacktoberfest
Dominant language
Shell
Stars
420
Forks
405
Avg merge
3d 15h
Merged PRs (30d)
3

Description

Currently, there is no detailed guidance for adding a missing library. Add documentation following the schema so that future pull requests are more likely to be complete.

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.

Research direction

Start by reading schema_human.json, the linked reference for the required library configuration. Add detailed contributing guidance based on that schema, and consider the work complete when future library pull requests can use the guidance to provide complete information.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.