osl-pocs / fqlearn

A library to help teaching mass transfer and thermodynamics.
https://osl-pocs.github.io/fqlearn/
Other
2 stars 0 forks source link

Include the project in OSL-Incubator for internship #1

Open EverVino opened 9 months ago

EverVino commented 9 months ago

@xmnlab I'm starting the steps to include this project in the internship program All suggestions will be appreciated

Description

Things to complete

xmnlab commented 9 months ago

Nice!! For the first item, maybr it should be rephrased .. maybe something like "the target user should not be restricted to an individual or a specific group (e.g. website for a company, an automation script for an organization to handle their own tasks). The project should be useful for anyone who has a similar problem to be solved "

This is a very big paragraph heheh but that is the idea, feel free to extract just the essence of that :)

xmnlab commented 9 months ago

I will take a look into the project in a bit

EverVino commented 9 months ago

@xmnlab It is ready for a review. This project is applying for the internship program. If something needs to be added I can complete it.

xmnlab commented 9 months ago

thanks @EverVino ! I am taking a look into that now

xmnlab commented 9 months ago

@EverVino , I think that for now it is ok to be included to the internship program :)

thanks for working on that.

there are some points that should be fixed later, such as docstrings, tests, but I think that is in a good shape to be listed in the Internship projects list!

ah the only one thing that is missing is the license. there is just an empty file there, but we need proper license there.

If you don't have anyone in mind, maybe you should consider BSD-3-Clause.

but feel free to pick anyone listed here https://opensource.org/licenses/

EverVino commented 9 months ago

Thanks @xmnlab I'm gonna update the license and send a PR to update internship form