🐈 Task: Create a DEVELOPMENT.md file

[GemmaTuron]

We currentluy do not have a DEVELOPMENT.md file. Please read GitHub's guidelines for this document, and do not tackle this issue unless you have successfully completed a first code contribution to Ersilia.

An example of a good DEVELOPMENT.md instruction file can be viewed here. Please only use this for inspiration purposes.

In particular, we want to have the following sections:

Getting Started

• This section should highlight installation instructions, including emphasizing on the fact that Ersilia only works within Linux or Linux like environments, eg, MacOS, or WSL.
• This section should also include an example for running a model focusing on usage of the verbose -v flag within ersilia which is especially useful for developers to debug and troubleshoot issues.
• It is also worthwhile to mention GitHub Codespaces here as a useful cloud IDE to facilitate development in case a contributor is unable to set up ersilia locally.

Ersilia Artifacts

• This section should talk about the EOS directory that gets created within the user's $HOME path, and include an explanation for its specific sub-folders and their contents. Please use this issue to post your understanding and questions about this directory so the maintainers can you help you in crafting a useful set of instructions.

Creating a PR

• This section should detail the PR creation and approval process, as well as including tips on including testing information, in case the related issue addressed in the PR is a bug or enhancement.

[baimamboukar]

Hello @GemmaTuron 👋
I would like to work on this issue.

[DhanshreeA]

Hi @baimamboukar if you are an Outreachy applicant and have not completed the initial set of tasks, then we cannot assign issues to you. Thank you for your understanding.

[Khushalsarode]

@DhanshreeA could you please elaborate what are you referring " have not completed the initial set of tasks " ?
need some help for getting started!

[egbadon-victor]

Hey @Khushalsarode

What our mentor @DhanshreeA means is that there are some general tasks that are to be done before you can be assigned an issue to work on.

https://ersilia.gitbook.io/ersilia-book/contributors/internships/outreachy-winter-2024

Here is the link containing everything you need to know about this contribution period. Cheers!

[Ajoke23]

Hi @DhanshreeA. Could you please assign this task to me as soon as my first PR has been merged?

[DhanshreeA]

Go ahead @Ajoke23!

[Ajoke23]

Thank you @DhanshreeA

[dzumii]

@Ajoke23 How is it going? Any progress?

[Ajoke23]

@Ajoke23 How is it going? Any progress?

Yes, it's going on well. I will making a pull request shortly

[DhanshreeA]

Closed in #1318