Skip to content

Conversation

vbrazo
Copy link
Member

@vbrazo vbrazo commented Feb 16, 2020

This PR suggests a versioning structure for V by example.

Issue

Closes #163

A Note on Example Versions

All examples should include the following header:

---
version: 3.5.1
example_title: JSON
---

Change the version attribute according to the following rules:

  • MAJOR — You (re)wrote the whole thing. Your new content will need some translation.
  • MINOR — Added or removed some content, few sentences, etc.
  • PATCH — Spelling, typos. Probably not translated stuff.

We follow SemVer.org pattern. This is important because we use that to determine and inform translators of new content that requires translation.

@vbrazo vbrazo added the documentation Improvements or additions to documentation label Feb 16, 2020
@vbrazo vbrazo self-assigned this Feb 16, 2020
@vbrazo vbrazo changed the title Add versioning structure to help translations keep up-to-date Add versioning structure to help translations keep the project up-to-date Feb 16, 2020
@vbrazo vbrazo requested a review from Delta456 February 16, 2020 01:24
@Delta456
Copy link
Member

Looks good

@vbrazo vbrazo merged commit d404fdf into master Feb 16, 2020
@vbrazo vbrazo deleted the add-versioning-structure branch February 16, 2020 19:30
@Delta456 Delta456 mentioned this pull request Mar 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add versioning header to help translators keep V by Example up-to-date
2 participants