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.

Sign up for GitHub

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

Jump to bottom

Update README to cover uncovered topics #75

Open
3 tasks
JudahSan opened this issue Oct 9, 2023 · 0 comments
Open
3 tasks

Update README to cover uncovered topics #75

JudahSan opened this issue Oct 9, 2023 · 0 comments
Labels
DifficultyLevelVeryEasy This means the dificulcy level for this task is;Easier Than Easy or a piece of cake hactoberfest Hacktoberfest recommended issues

Comments

@JudahSan
Copy link
Collaborator

JudahSan commented Oct 9, 2023

The README file for this project currently covers the following topics:

Ruby version
System dependencies
Configuration
Database creation
Database initialization

However, there are a few important topics that are not currently covered, including:

  • How to run the test suite
  • Services (job queues, cache servers, search engines, etc.)
  • Deployment instructions

These topics are important for new users and contributors to know, so it would be helpful to add them to the README file.
@JudahSan JudahSan added DifficultyLevelVeryEasy This means the dificulcy level for this task is;Easier Than Easy or a piece of cake hactoberfest Hacktoberfest recommended issues labels Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
DifficultyLevelVeryEasy This means the dificulcy level for this task is;Easier Than Easy or a piece of cake hactoberfest Hacktoberfest recommended issues
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JudahSan