Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Lacking #37

Open
shellscape opened this issue Dec 30, 2019 · 1 comment
Open

Documentation Lacking #37

shellscape opened this issue Dec 30, 2019 · 1 comment
Labels
enhancement New feature or request

Comments

@shellscape
Copy link

This specification needs more verbose documentation.

  • What is a "Substitution"?
  • What does a "previousTag" represent? (Beyond the previous tag of... something)
  • What does a "currentTag" represent? How is it used by consumers (standard-version, etc)? What are use cases for changing it?

I've been pretty confounded trying to utilize bits and pieces of the projects in the org, and while I greatly appreciate that they exist and that people are passionate about the project, the documentation is so lacking as to cause significant frustration. It's the easiest part to affect the greatest impact on a userbase.
@bcoe bcoe added the enhancement New feature or request label Dec 31, 2019
@alanhe421
Copy link

I am also confused about what specification is

The documentation is not accurate enough

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Milestone
No milestone
Development

No branches or pull requests
3 participants
@shellscape @bcoe @alanhe421