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

Determine how we are going to handle software releases and versioning - write a brief README #8

Open
btam8703 opened this issue Oct 20, 2023 · 2 comments · May be fixed by #15
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@btam8703
Copy link
Contributor

btam8703 commented Oct 20, 2023

Never done anything like this before but gonna take a shot when I have time after midterms:

Versioning practices
Software releasing

Where are the AlbertaSat sprint periods? Software releases and release notes should be aligned timewise with those sprints.

@btam8703 btam8703 self-assigned this Oct 20, 2023
@btam8703 btam8703 converted this from a draft issue Oct 20, 2023
@btam8703 btam8703 moved this from Todo to In Progress in (OLD) ExAlta3 Project Management for Software Nov 1, 2023
@btam8703 btam8703 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Nov 9, 2023
@btam8703
Copy link
Contributor Author

btam8703 commented Nov 9, 2023

@dheadrick1618 could you take a look at what I have right now and provide any suggestions? I think semantic versioning is great for a project of this magnitude but the main things I am not sure are the following:

  • Timeline wise what are we following for releases? I know we aren't following the usual albertasat redmine sprints.
  • How are we going to keep track of versions/release and patch notes? Having some way to compile notes to refer to later would be nice. Perhaps we could have a whole other document dedicated to just this?
  • In terms of technical knowledge I basically have very little. Let me know if there's anything specific I should add regarding this

@dheadrick1618
Copy link
Member

dheadrick1618 commented Jan 9, 2024

Apologies for getting to this so late.

I dont think it makes sense to have versioning related to the sprints at all, for us at least the sprints are likely much more common than we would be able to push new versions.

I like the idea of having a single document (maybe in the documentation repo) devoted to describing each major, minor, patch release changes.

Great work on referencing the semantic versioning that big software companies seem to like to do. As for the other document it has a lot of great points, but I think we don't need a 'dev' branch because we (I think) should follow a git feature branch style workflow, as it is relatively simple. ( https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow )

I think at this point we just need to define what qualifies as a major, minor, and patch. Could you create a markdown doc in the documentation repo ( https://github.com/AlbertaSat/ex3_documentation ), and from that we can start to discuss how we want to define the different types of 'versions' for our releases there.

Good work :)

@btam8703 btam8703 removed the help wanted Extra attention is needed label Jan 10, 2024
@btam8703 btam8703 linked a pull request Feb 14, 2024 that will close this issue
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
Development

Successfully merging a pull request may close this issue.

2 participants