HowProgrammingWorks / HowProgrammingWorks/CodeStyle
Write the JavaScript styleguide
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 4
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
For the moment our JavaScript styleguide exists implicitly and can only be inferred from reading our source code. The eslint config that we use in our projects covers the most essential parts of the code style, but a great deal of style-related things cannot be checked by linter, though the eslint config should definitely be placed in this repo too. We need to document our JavaScript code style and save these conventions both there and in Metarhia repositories.
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
Start by reviewing the existing JavaScript source code and the eslint configuration used in the projects to identify conventions that are not linted. Document the conventions in a styleguide, add the eslint configuration to this repository, and ensure the resulting guidance can be saved in Metarhia repositories.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, javascript
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100