mapbox/node-cpp-skel

Improving code formatting docs with additional efficiency recommendations

Open

#97 opened on Jan 3, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (9 forks)auto 404
help wanted

Repository metrics

Stars
 (74 stars)
PR merge metrics
 (PR metrics pending)

Description

node-cpp-skel has support for:

  • a .clang-format style file that provides formatting rules (which can be modified/customized)
  • make format an easy command to run to consistently format all the code (and ensure a consistent version of clang-format is available)
  • a travis job that runs a check to catch when you've forgotten to format your code and in contains incorrectly formatted code (uses same clang-format version as is used locally by make format)

We can improve by adding docs/recommendations for developers for how to:

Contributor guide

Research direction
Read the current formatting documentation in the repo and research the linked resources for git pre commit hooks and editor integration.
Tech stack
cppnodejs
Domain
documentationdeveloper experiencetooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80