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

Add FAQ document #5

Open
Exadra37 opened this issue Apr 29, 2017 · 9 comments
Open

Add FAQ document #5

Exadra37 opened this issue Apr 29, 2017 · 9 comments
Assignees

Comments

@Exadra37
Copy link
Member

Exadra37 commented Apr 29, 2017

While Explicit Versioning is gaining traction, some questions will popup overtime and this questions may be already documented, but normally we Humans are good in overlook them when reading the documentation.

This can happens because:

  • we are reading in a rush.
  • not reading with attention.
  • reading when tired.
  • we are being simple lazy and instead of reading we just open a new issue and wait for somebody else to do the work for us.

As a Moderator in a forum I see all them happen a lot, specially the last one.

So the FAQ will be a place to put the Question and Reply for the most pertinent questions we will find overtime.

Anyway when a question popups and the document is referring to is not clear enough, than we must amend the document instead.

This FAQ document will be separated from the README holding the Specification.

@Exadra37
Copy link
Member Author

Exadra37 commented May 6, 2017

@sapioit @colomet @bmitch

Any suggestions about questions to go into the FAQ?

@bmitch
Copy link

bmitch commented May 6, 2017

@Exadra37 I could write up some questions if you want to answer them?

@Exadra37
Copy link
Member Author

Exadra37 commented May 6, 2017

@bmitch put here your questions than we will see if they are a good fit for the FAQ or the documents need to be updated to clarify that questions ;)

@bmitch
Copy link

bmitch commented May 6, 2017

Just off the top of my head:

  • What is explicit versioning?
  • How does it differ from other versioning methods?
  • What advantages does explicit versioning provide?
  • Is it compatible with composer (or other package management software).
  • Who is behind explicit versioning?
  • When should I use explicit versioning?
  • Why should I use explicit versioning?

@Exadra37 Exadra37 self-assigned this May 7, 2017
@Exadra37
Copy link
Member Author

Exadra37 commented May 7, 2017

@bmitch nice set of FAQ questions... thanks :)

@sapioit
Copy link
Contributor

sapioit commented May 7, 2017

Also:

  • What explicit versioning is not?
  • What disadvantages does explicit versioning have?
  • When should I not use explicit versioning?
  • Why should I not use explicit versioning?

Just to make things more... explicit. (I know, I know, bad pun...)

@Exadra37
Copy link
Member Author

Exadra37 commented May 8, 2017

@sapioit

Since when Explicit Versioning has disadavantages 🙄

@sapioit
Copy link
Contributor

sapioit commented May 9, 2017

Since there are people who prefer a different versioning system. That would be the only disadvantage I can think of...

@Exadra37
Copy link
Member Author

Exadra37 commented May 9, 2017

@sapioit

I was making a joke ;)

Disadvantages:

  • you need to write 1 more digit and a dot.
  • enforces thinking more, once now is clear when a Incompatible Release is done.
  • encourages use of strong suites of tests to ensure that breaking changes will not happen without being intentional.

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

No branches or pull requests

3 participants