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

Create DEVELOPMENT.md file #1318

Merged
merged 8 commits into from
Oct 17, 2024
Merged

Conversation

Ajoke23
Copy link
Contributor

@Ajoke23 Ajoke23 commented Oct 11, 2024

Thank you for taking your time to contribute to Ersilia, just a few checks before we proceed

  • Have you followed the guidelines in our Contribution Guide
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully ran tests with your changes locally?

Description
Currently, Ersilia doesn't have a DEVELOPMENT.md file in the repository. The main aim is to create a DEVELOPMENT.md instruction file

Changes to be made
Add a development .md file in ersilia repository

Status

  • Added a getting started section that highlight installation instruction, the use of GitHub codespace as an alternative method and the uses of running a model with verbose -v flag.
  • Added Ersilia Artifacts section which focuses on various artifacts that is found in the EOS directory within the user's $HOME path
  • Added a Pull Request section that explains how to create a PR either by GitHub Desktop or GirHub Codespaces.I also made emphasis on testing the code using pytest -v
  • Added a "Create a Pull Request" section

To do
N/A

Is this pull request related to any open issue? If yes, replace issueID below with the issue ID

Related to #1270

Added the getting started and Ersilia Artifacts session
@Ajoke23 Ajoke23 changed the title Create DEVELOPMENT.md Create DEVELOPMENT.md file Oct 11, 2024
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
@Ajoke23
Copy link
Contributor Author

Ajoke23 commented Oct 13, 2024

Hi @DhanshreeA. Thanks for the suggestions. All necessary changes has been implemented

@Ajoke23
Copy link
Contributor Author

Ajoke23 commented Oct 15, 2024

Hi @DhanshreeA. All necessary changes has been made.
Please, I await your feedback and any suggestions (if there is)

DEVELOPMENT.md Outdated

- ### Installation of Ersilia on local computer
To get started with Ersilia installation, there are few dependencies that needs to be installed before proceeding to installation of Ersilia. Please, check the package requirement in the [Installation Guide](https://ersilia.gitbook.io/ersilia-book/ersilia-model-hub/installation)
1. Once the required dependencies has been met, open a terminal and set up a Conda environment.
Copy link
Member

Choose a reason for hiding this comment

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

Rephrase "Once the required dependencies has been met" to "Once the required dependencies has been installed" or "Once the dependency requirements have been met"

DEVELOPMENT.md Show resolved Hide resolved
@Ajoke23
Copy link
Contributor Author

Ajoke23 commented Oct 17, 2024

Hi @DhanshreeA. I have implemented all the necessary changes

@DhanshreeA DhanshreeA merged commit 6599cdf into ersilia-os:master Oct 17, 2024
18 checks passed
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.

2 participants