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

provide history of older "releases" of the codebase. #24

Open
mathematicalmichael opened this issue Aug 6, 2020 · 3 comments
Open

provide history of older "releases" of the codebase. #24

mathematicalmichael opened this issue Aug 6, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mathematicalmichael
Copy link
Collaborator

maybe we keep the original matlab code anyway? I don't know, perhaps put it on a separate branch with some mention of the archival process on the README. We can actually just refer people to the last commit number before the merge of #15 and provide some backstory in a blog post.

That said I eventually do want auto-generated documentation and it would be nice if some markdown file from this repo just got incorporated into the docs, however that happens.

Part of this process should involve re-writing the README, but I'll raise another issue for that.

@djdebonis
Copy link
Collaborator

I do like this idea because it demonstrates the evolution of your software dev journey, Mind the Grow as a company, and the software itself.

@mathematicalmichael
Copy link
Collaborator Author

yeah but the beauty of git is that we can literally just hyperlink to the state of the project at any time in the past.

@mathematicalmichael
Copy link
Collaborator Author

todo:

  • create a release for the major checkpoints
  • create a changelog and link to the releases + git hashes from there

super low priority though.

@mathematicalmichael mathematicalmichael changed the title archival process of old code + README provide history of older "releases" of the codebase. Jul 26, 2021
@mathematicalmichael mathematicalmichael added the documentation Improvements or additions to documentation label Jul 26, 2021
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

No branches or pull requests

2 participants