yoanbernabeu / Airtable-Client-Bundle

Simple Client for Airtable API
MIT License
33 stars 12 forks source link

About branch naming #18

Closed Spomky closed 3 years ago

Spomky commented 3 years ago

Hi,

I noted this repository has only one branch named main. As the project evolves, at some point you will undoubtedly need to manage versions. What about starting with a branch 1.0 and push tags when the bundle is stable? Next versions will be merge in this branch (bug fixes), a branch 1.x (e.g. new features) and a branch 2.x for major changes. WDYT?

TangoMan75 commented 3 years ago

Hi @Spomky 👋 What's wrong with standard gitflow ?

yoanbernabeu commented 3 years ago

You're right, we need to set up version control.

We will follow the best practices of a Symfony Bundle using SemVer.

Packagist also recommends the use of SemVer. Packagist offers the following approach:

New versions of your package are automatically fetched from tags you create in your VCS repository. The easiest way to manage versioning is to just omit the version field from the composer.json file. The version numbers will then be parsed from the tag and branch names.

However, I would like to keep the process simple. Can't we just use tags?

Spomky commented 3 years ago

What's wrong with standard gitflow ?

Nothing wrong with gitflow.

However, I would like to keep the process simple. Can't we just use tags?

Yes actually this is exactly what you should do. You will put tags like 1.0.0 on commits. The question is about branches. Symfony best practices are very clever on that point. Have a look on their branch organization. This way you can work on any versions an easy way. The process is very similar to the one you use. The only difference is that instead of creating new working branches from the main one, you start from a x.y one.

yoanbernabeu commented 3 years ago

My proposal: As long as we are in the initial version (tag 0. . ), I suggest that we do not use branches. When version 1.0.0 is released, we will be implementing the branch naming system.

Is it okay for you ?

Spomky commented 3 years ago

That's just naming suggestion. If it is 👌 for you, it's 👌 for me as well! Proposal accepted ✔.