nolanlawson/chord-magic

Allow prettyPrinting in Nashville Number System format

Open

#10 opened on Jun 6, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (6 forks)github user discovery
enhancementhelp wanted

Repository metrics

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

Description

Would be great to be able to see chords in Nashville Number System format, ie.

Standard format

screen shot 2018-06-06 at 18 02 49

Nashville Number System format

screen shot 2018-06-06 at 18 02 37

In the screenshots above, we have managed the above using a version of your sharpsOnly array (see below), but it would be cool to incorporate this directly into chord-magic

const nashville = [
		1,     // 'A',
		'A#',  // 'A#',
		2,     // 'B',
		'C',   // 'C',
		3,     // 'C#',
		4,     // 'D',
		'D#',  // 'D#',
		5,     // 'E',
		'F',   // 'F',
		6,     // 'F#',
		'G',   // 'G',
		7      // 'G#'
	];
	const distance = getKeyDiff( key, 'A' );

	return prettyPrint( transpose( parse( chord ), distance ), { naming: nashville } );

Contributor guide

Research direction
Implement a Nashville Number System naming option in prettyPrint. Study the existing prettyPrint function and the 'naming' parameter, then create a mapping from chord notes to Roman numerals based on the key. Refer to the user's provided nashville array as a starting point.
Tech stack
javascript
Domain
api
Issue type
Feature
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70