-
Notifications
You must be signed in to change notification settings - Fork 28
Improve intro texts #647
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
Improve intro texts #647
Conversation
FlorianK13
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this text. I left some comments, but I like the overall changes and think they are helpful for users.
…Ortimis/open-MaStR into feature-646-improve-intro-texts
|
Fixed the formatting issues in the rst syntax @FlorianK13 |
|
We switched to .rst some time ago to have a unified README template in all |
FlorianK13
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Ortimis I added a few minor changes - you can commit them directly within the github User interface if you agree with them.
Co-authored-by: Florian Kotthoff <[email protected]>
Co-authored-by: Florian Kotthoff <[email protected]>
Co-authored-by: Florian Kotthoff <[email protected]>
|
committed them! |
FlorianK13
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wanted to merge, but found more issues.
Co-authored-by: Florian Kotthoff <[email protected]>
Co-authored-by: Florian Kotthoff <[email protected]>
|
@nesnoj Do we have clear rules for our changelog file? Do we add changes to the README to the Changelog? |
No rule for this I think but I'd do so - also the docs intro page is adjusted ;) |
|
@Ortimis can you adapt the CHANGELOG.md file so that the first entries look like that: # Changelog
All notable changes to this project will be documented in this file.
For each version important additions, changes and removals are listed here.
The format is inspired from [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [v0.XX.X] unreleased - 202X-XX-XX
### Added
### Changed
- Adapt introduction text in README and docs
[#647](https://github.com/OpenEnergyPlatform/open-MaStR/pull/647)
### Removed
## [v0.16.0] Partial downloads with open-MaStR PartialPumpkinPull - 2025-11-26
### Added |
…Ortimis/open-MaStR into feature-646-improve-intro-texts
|
Test fail because of credentials error |
Fixes #646
Also addresses #644
Workflow checklist
Automation
Closes #646
PR-Assignee
Reviewer