jquery / jquery/contribute.jquery.org
Document consistency goods with files examples
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 28
- Forks
- 73
- PR merge metrics
- No merged PRs in 30d
Description
After a discussion on https://github.com/jquery/api.qunitjs.com/pull/114#issuecomment-150332207, it sounds we might use some examples of our kickstart configuration files we already use on most projects.
That might include, not exclusively:
.editorconfig- jshint and jscs configs
- task runner configurations (currently grunt)
- a whole CI configuration docs (this might become into another issue for individual tracking)
As the style guides, these might be strongly enforced, but breaking some rules - to explore to new standards - are welcome.
Contributor guide
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
Start by reading the discussion linked in pull request 114 and reviewing the existing kickstart configuration files used by projects. Compare the available .editorconfig, jshint and jscs configs, Grunt task runner configurations, and CI documentation, then define the selected examples and document them consistently; done means the agreed examples are included and any separate CI scope is identified.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100