Added DEVELOPING.md to include versioning process steps #127

Manually merged
sloum merged 3 commits from release-process-information into develop 2020-01-23 05:46:25 +00:00
Collaborator

This is intended to fix #108.

It is designed as a reminder, not an exhaustive process document. It also helps to inform new people on the change and release processes.

Not having done the process myself, there are probably some errors. The document would need to be validated.

The issue originally described not wanting to forget how the release process occurs. Maybe there is another way to achieve this. I have had this on my mind for a while now, not being sure this is the right approach, but want to get it completed one way or another.

This is intended to fix #108. It is designed as a reminder, not an exhaustive process document. It also helps to inform new people on the change and release processes. Not having done the process myself, there are probably some errors. The document would need to be validated. The issue originally described not wanting to forget how the release process occurs. Maybe there is another way to achieve this. I have had this on my mind for a while now, not being sure this is the right approach, but want to get it completed one way or another.
asdf added the
non-code
non-functional
documentation
labels 2020-01-08 04:02:29 +00:00
sloum approved these changes 2020-01-08 05:08:30 +00:00
sloum left a comment
Owner

I think this is really good. It documents the process and our thoughts on the process (you captured mine pretty well). I agree that we do not need to be rulesy or dogmatic about it unless an issue arises that forces that sort of thing, but it is a good guide tot he preferred course of action.

I think this is really good. It documents the process and our thoughts on the process (you captured mine pretty well). I agree that we do not need to be rulesy or dogmatic about it unless an issue arises that forces that sort of thing, but it is a good guide tot he preferred course of action.
@ -0,0 +63,4 @@
As part of the software release process, any part of the version number may change:
- Urgent changes increment the **patch** number
Owner

In general I have been treating patch version changes as changes that will eventually get to master as part of either a minor version or major version merge, but the patches will be versioned as part of the develop branch (master should not generally have things on it with a patch other than 0, unless there is an error fix or the like).

So patches accrue on develop and are listed on the releases tab (but only as minor releases - since they ahve tags tildegit considers it a release of some sort) so people wanting latest greatest can pull those tags. Once enough patches build up develop will get merged into master and the minor version will be updated and the patch reset to 0.

Major versions are akin to python going from 2 - 3 and will not happen often at all (potentially many years in between).

In general I have been treating patch version changes as changes that will eventually get to master as part of either a minor version or major version merge, but the patches will be versioned as part of the develop branch (master should not generally have things on it with a patch other than 0, unless there is an error fix or the like). So patches accrue on develop and are listed on the releases tab (but only as minor releases - since they ahve tags tildegit considers it a release of some sort) so people wanting latest greatest can pull those tags. Once enough patches build up develop will get merged into master and the minor version will be updated and the patch reset to 0. Major versions are akin to python going from 2 - 3 and will not happen often at all (potentially many years in between).
Author
Collaborator

OK, I think we have the same understanding on this, but the way I've written it makes it seem that new changes merged to develop aren't considered as releases. Is that your impression as well?

The document can be amended to indicate new changes merged to develop are still part of the release process, but are "development releases" (or a different name).

OK, I think we have the same understanding on this, but the way I've written it makes it seem that new changes merged to develop aren't considered as releases. Is that your impression as well? The document can be amended to indicate new changes merged to develop are still part of the release process, but are "development releases" (or a different name).
Owner

I think that is a good call. I would not consider them full releases. Development releases is a good term.

I think that is a good call. I would not consider them full releases. Development releases is a good term.
Author
Collaborator

I've reduced the size of this document now, hopefully focussing on the important parts. If no issues let's merge it in.

I've reduced the size of this document now, hopefully focussing on the important parts. If no issues let's merge it in.
sloum approved these changes 2020-01-23 05:45:09 +00:00
sloum left a comment
Owner

This looks good! Thanks for your work on this :) I think it makes good sense and should be approachable.

This looks good! Thanks for your work on this :) I think it makes good sense and should be approachable.
sloum closed this pull request 2020-01-23 05:46:25 +00:00
Owner

This has been merged in and a release has been created.

This has been merged in and a release has been created.
asdf deleted branch release-process-information 2020-01-28 22:02:50 +00:00
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: sloum/bombadillo#127
No description provided.