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

Refine readme #58

Open
kamilsi opened this issue Feb 15, 2024 · 1 comment
Open

Refine readme #58

kamilsi opened this issue Feb 15, 2024 · 1 comment

Comments

@kamilsi
Copy link
Contributor

kamilsi commented Feb 15, 2024

          Still does not

Originally posted by @kamilsi in #55 (comment)

@kamilsi
Copy link
Contributor Author

kamilsi commented Feb 27, 2024

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.

kamilsi added a commit that referenced this issue Mar 8, 2024
Issue #58 Added descriptions of the remaining endpoints implemented in API
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

When branches are created from issues, their pull requests are automatically linked.

1 participant