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

Update README.md #505

Merged
merged 3 commits into from
Aug 20, 2024
Merged

Update README.md #505

merged 3 commits into from
Aug 20, 2024

Conversation

mforets
Copy link
Collaborator

@mforets mforets commented Jul 9, 2024

(i dont understand what does "experimental" communicate)

@mforets mforets requested a review from mvanzulli July 9, 2024 17:06
@mforets
Copy link
Collaborator Author

mforets commented Jul 9, 2024

... If the original idea was to warn potential industrial or academic use cases that this software is still at an early stage of development, it can be said more explicitly (although the < 1.x version somehow communicates that). Eg. like so:

This software is currently under development and may contain bugs or incomplete features. It is intended for testing and educational purposes only. Do not use this software for any critical applications or in the design and construction of actual buildings. The developers assume no responsibility for any consequences resulting from the use of this software in real-world applications.

@mvanzulli
Copy link
Member

The original idea was to add a disclaimer that this is not the actual main package planned in the roadmap of ONSAS to migrate all the features of ONSAS.m and development for professional applications. Given that, I'm not against removing adding the following sentence into the REAMDE.md:

This software is currently under development and may contain bugs or incomplete features. It is intended for testing and educational purposes only. 

and remove the (experimental) from the name.

@jorgepz
Copy link
Member

jorgepz commented Jul 27, 2024

Hi! As Mauricio says the idea was to add an explicit disclaimer. Although this could be clear in the version for software experts, an explicit disclaimer is needed to lower expectations and preparing users for not-fully-developed features.

I agree with Mauricio's text proposal.

Copy link
Member

@mvanzulli mvanzulli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jorgepz for the feedback. Feel free @mforets to add the sentence

@mforets
Copy link
Collaborator Author

mforets commented Aug 20, 2024

i made some edits, shall we merge now?

@mvanzulli mvanzulli merged commit 6f5aa27 into main Aug 20, 2024
4 checks passed
@mvanzulli
Copy link
Member

i made some edits, shall we merge now?

Yes, thanks for the changes 👌🏼

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants