search

ttscience / unbiased

API for clinical trial randomization
https://ttscience.github.io/unbiased/
Other
8 stars 1 forks source link

Refine readme #58

Open kamilsi opened 6 months ago

kamilsi commented 6 months ago 
          Still does not

_Originally posted by @kamilsi in https://github.com/ttscience/unbiased/pull/55#discussion_r1490803442_

kamilsi commented 6 months ago

Couple more points after #60 review:

  1. Developer Instance Setup Instructions: Currently, the README lacks detailed instructions on how to set up a development instance, particularly for those using RStudio. It would be immensely helpful to include step-by-step guidance on how to configure the development environment, including any required dependencies and how to get the project running locally in RStudio. This could help new contributors get up to speed more quickly.
  2. Database Preparation: The section on database setup leaves some questions unanswered. Specifically, it's not clear whether the database should already contain certain data before starting, or if it's expected to be empty. Additionally, guidance on which database image to use for creating the development database would be beneficial. Clarifying these points can help developers understand how to properly prepare their development environment for working with the project.
  3. Schema Migration Handling: Another point of confusion is regarding schema migrations. It's not specified whether schema migrations need to be triggered manually by the developer or if there's an automated process within the project's setup that handles this. Including detailed instructions on how schema migrations are managed (e.g., through command-line utilities, automatically on server start, etc.) would demystify the initial setup process and ensure developers know how to manage database schemas effectively.