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.

Sign up for GitHub

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

Versioning and Changelog #313

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Versioning and Changelog #313

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d2caa4a
Add initial CHANGELOG.md with detail about initial release.
jatkinson1000 Mar 6, 2025
96702a0
Update developer docs to describe versioning process and Changelog.
jatkinson1000 Mar 6, 2025
6963a7a
Add changelog page to website (pulls from the repo changelog) and ref…
jatkinson1000 Mar 12, 2025
88f5906
Update Changelog to reference online docs, and add guidance on change…
jatkinson1000 Mar 12, 2025
6b7d7bc
Update changelog to detail the most recent pull requests.
jatkinson1000 Mar 12, 2025
fa9418a
Small wording and typo changes.
jatkinson1000 Mar 12, 2025
0007858
Punctuation fix
jatkinson1000 Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added


### Changed

- fortitude dependency version increased to 0.7.0

### Removed


## [1.0.0] - 2025-03-05

### Added

- First release of FTorch accompanying pulication in JOSS
- MIT License
- Notable features of the library include:
- Representation of Torch tensors and models in Fortran
- Ability to run inference of Torch models from Fortran
- Early implementation of autograd features for Torch tensors in Fortran
- Comprehensive examples suite showcasing usage
- Testing suites:
- Unit, using [pFUnit](https://github.com/Goddard-Fortran-Ecosystem/pFUnit)
- Integration, based on examples
- Code quality and static analysis checks
- Documentation:
- README.md and associated files in repository
- Online API and comprehensive docs build using [FORD](https://forddocs.readthedocs.io/)

[unreleased]: https://github.com/Cambridge-ICCS/FTorch/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/Cambridge-ICCS/FTorch/releases/tag/v1.0.0
17 changes: 17 additions & 0 deletions pages/developer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,23 @@ checks on all opened pull requests before they are merged.

## Documentation

### Versioning and Changelog

FTorch has follows [semantic versioning](https://semver.org/).

- Major releases for API changes
- Minor releases periodically for new features
- Patches for bug fixes

New minor releases are made when deemed appropriate by maintainers by adding a tag to
the commit and greating a corresponding GitHub Release.

A log of notable changes to the software is kept in `CHANGELOG.md`.
This follows the conventions of [Keep a Changelog](https://keepachangelog.com/) and should
be updated by contributors and maintainers as part of a pull request when appropriate.

### API Documentation

The API documentation for FTorch is generated using
[FORD](https://forddocs.readthedocs.io/en/latest/).
For detailed information refer to the
Expand Down