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.

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

Improve versioning documentation #106

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve versioning documentation #106

wants to merge 3 commits into from

Conversation

diegoquintanav
Copy link

I added a section in the README to guide new users in using the settings file. This because I ran into this problem right away from the start #96

Add an entry pointing to the regular expresion used to parse version
tags, to solve questions like "why my tag `v0.1` is not being detected?"
@codecov
Copy link

codecov bot commented Oct 23, 2018

Codecov Report

Merging #106 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #106   +/-   ##
=======================================
  Coverage   88.45%   88.45%           
=======================================
  Files           2        2           
  Lines         840      840           
  Branches      168      168           
=======================================
  Hits          743      743           
  Misses         58       58           
  Partials       39       39

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d72a0f0...8f92621. Read the comment docs.

@vaab
Copy link
Owner

vaab commented Oct 24, 2018

Thanks for the proposal, I fully understand the need and adding to the documentation such links will help. Although, I'll need to think if there isn't a better place in the documentation to put this section. The title, the list with only one element makes all this not really finished. Also, on the cosmetic level, there are a few spelling errors, no wrapping on 80 cols. But no need to work on that now. I'll keep your PR open because I really feel that most of your text have it's place in the documentation.
I don't have a lot of time at my disposal currently, it might take some time before I move forward on this.

@diegoquintanav
Copy link
Author

Hi! I agree that one item in the list beats the purpose of a list. Perhaps a FAQ section?

The only spelling error I see is "defaults", which I'll gladly fix.

Let me know what you think. Take your time!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants