11ty / 11ty/docs

No documentation on contributing to the docs

Open
#1,810 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nunjucks
Stars
547
Forks
726
Avg merge
2h 23m
Merged PRs (30d)
3

Description

The How can I contribute? page does not actually contain any information about contributing code to either Eleventy or the documentation. For folks who want to try to help maintain the docs, it might be nice to have some information about what is expected as far as forks, branches, and pull requests are concerned. And if there are any requirements around formatting and tests, those should be enumerated, too.

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 How can I contribute? page linked in the issue and review the repository’s existing contribution guidance. Document the expected fork, branch, and pull request workflow for code and documentation, along with any formatting and test requirements. Done means the page gives prospective contributors enough information to submit a compliant change.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.